logo
API docs by Redocly

CZERTAINLY Core API (2.11.1-SNAPSHOT)

Download OpenAPI specification:Download

CZERTAINLY: getinfo@czertainly.com URL: https://www.czertainly.com License: MIT License

REST API for CZERTAINLY Core

CZERTAINLY Documentation

Connector Management

Connector Management API

Get details of a Connector

path Parameters
uuid
required
string

Connector UUID

Responses

Response samples

Content type
application/json
{
  • "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
  • "name": "Name",
  • "functionGroups": [
    ],
  • "url": "http://network-discovery-provider:8080",
  • "authType": "none",
  • "authAttributes": [
    ],
  • "status": "CONNECTED",
  • "customAttributes": [
    ]
}

Edit a Connector

path Parameters
uuid
required
string

Connector UUID

Request Body schema: application/json
url
string

URL of the Connector to connect

authType
string (AuthType)
Enum: "none" "basic" "certificate" "apiKey" "jwt"

Type of authentication for the Connector

Array of objects (RequestAttributeDto)

List of authentication Attributes. Required if the authentication type is not NONE

Array of objects (RequestAttributeDto)

List of Custom Attributes

Responses

Request samples

Content type
application/json
{
  • "url": "http://network-discovery-provicer:8080",
  • "authType": "none",
  • "authAttributes": [
    ],
  • "customAttributes": [
    ]
}

Response samples

Content type
application/json
{
  • "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
  • "name": "Name",
  • "functionGroups": [
    ],
  • "url": "http://network-discovery-provider:8080",
  • "authType": "none",
  • "authAttributes": [
    ],
  • "status": "CONNECTED",
  • "customAttributes": [
    ]
}

Delete a Connector

path Parameters
uuid
required
string

Connector UUID

Responses

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Reconnect to a Connector

path Parameters
uuid
required
string

Connector UUID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Approve a Connector

path Parameters
uuid
required
string

Connector UUID

Responses

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Reconnect multiple Connectors

Request Body schema: application/json

Connector UUIDs

Array
string

Responses

Request samples

Content type
application/json
[
  • "c2f685d4-6a3e-11ec-90d6-0242ac120003",
  • "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Connect to a Connector

Request Body schema: application/json
url
required
string

URL of the Connector to connect

uuid
string

UUID of the Connector. Mandatory if connection is needed for the same Connector

authType
required
string (AuthType)
Enum: "none" "basic" "certificate" "apiKey" "jwt"

Type of authentication for the Connector

Array of objects (RequestAttributeDto)

List of authentication Attributes. Required if the authentication type is not NONE

Responses

Request samples

Content type
application/json
{
  • "url": "http://network-discovery-provicer:8080",
  • "uuid": "string",
  • "authType": "none",
  • "authAttributes": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Approve multiple Connector

Request Body schema: application/json

Connector UUIDs

Array
string

Responses

Request samples

Content type
application/json
[
  • "c2f685d4-6a3e-11ec-90d6-0242ac120003",
  • "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

Content type
application/json
{
  • "message": "Error message"
}

List Connectors by Function Group and Kind

query Parameters
functionGroup
string (FunctionGroupCode)
Enum: "credentialProvider" "legacyAuthorityProvider" "authorityProvider" "discoveryProvider" "entityProvider" "complianceProvider" "cryptographyProvider" "notificationProvider"

Enumerated code of functional group

kind
string
status
string (ConnectorStatus)
Enum: "waitingForApproval" "connected" "failed" "offline"
Example: status=CONNECTED

Status of the Connector

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new Connector

Request Body schema: application/json
name
required
string

Name of the Connector

url
required
string

URL of the Connector to connect

authType
required
string (AuthType)
Enum: "none" "basic" "certificate" "apiKey" "jwt"

Type of authentication for the Connector

Array of objects (RequestAttributeDto)

List of authentication Attributes. Required if the authentication type is not NONE

Array of objects (RequestAttributeDto)

List of Custom Attributes

Responses

Request samples

Content type
application/json
{
  • "name": "Connector1",
  • "url": "http://network-discovery-provicer:8080",
  • "authType": "none",
  • "authAttributes": [
    ],
  • "customAttributes": [
    ]
}

Response samples

Content type
application/json
{
  • "uuid": "string"
}

Delete multiple Connectors

Request Body schema: application/json

Connector UUIDs

Array
string

Responses

Request samples

Content type
application/json
[
  • "c2f685d4-6a3e-11ec-90d6-0242ac120003",
  • "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

Content type
application/json
[
  • {
    }
]

Validate Attributes

path Parameters
uuid
required
string

Connector UUID

functionGroup
required
string

Function Group name

kind
required
string

Kind

Request Body schema: application/json
Array
uuid
required
string

UUID of the Attribute

name
required
string

Name of the Attribute

contentType
required
string (AttributeContentType)
Enum: "string" "text" "integer" "boolean" "float" "date" "time" "datetime" "secret" "file" "credential" "codeblock" "object"

Type of the attribute content.

required
Array of BooleanAttributeContent (object) or CodeBlockAttributeContent (object) or CredentialAttributeContent (object) or DateAttributeContent (object) or DateTimeAttributeContent (object) or FileAttributeContent (object) or FloatAttributeContent (object) or IntegerAttributeContent (object) or ObjectAttributeContent (object) or SecretAttributeContent (object) or StringAttributeContent (object) or TextAttributeContent (object) or TimeAttributeContent (object) (BaseAttributeContentDto)

Content of the Attribute

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Check Health of a Connector

path Parameters
uuid
required
string

Connector UUID

Responses

Response samples

Content type
application/json
{
  • "status": "ok",
  • "description": "string",
  • "parts": {
    }
}

Get attributes of all Function Groups

path Parameters
uuid
required
string

Connector UUID

Responses

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Get Attributes from a Connector

path Parameters
uuid
required
string

Connector UUID

functionGroup
required
string (FunctionGroupCode)
Enum: "credentialProvider" "legacyAuthorityProvider" "authorityProvider" "discoveryProvider" "entityProvider" "complianceProvider" "cryptographyProvider" "notificationProvider"

Function Group name

kind
required
string

Kind

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Force Delete multiple Connectors

Request Body schema: application/json

Connector UUIDs

Array
string

Responses

Request samples

Content type
application/json
[
  • "c2f685d4-6a3e-11ec-90d6-0242ac120003",
  • "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

Content type
application/json
[
  • {
    }
]

User Management

User Management API

Get user details

path Parameters
userUuid
required
string

User UUID

Responses

Response samples

Content type
application/json
{
  • "uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
  • "username": "user1",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "description": "string",
  • "groupName": "string",
  • "groupUuid": "string",
  • "enabled": true,
  • "systemUser": true,
  • "certificate": {
    },
  • "roles": [
    ],
  • "customAttributes": [
    ]
}

Update User

path Parameters
userUuid
required
string

User UUID

Request Body schema: application/json
description
string

Description of the user

firstName
string

First name of the user

lastName
string

Last name of the user

email
required
string

Email of the user

groupUuid
string

Group UUID of the user

certificateData
string

Base64 Content of the admin certificate

certificateUuid
string

UUID of the existing certificate in the Inventory. Mandatory if certificate is not provided

Array of objects (RequestAttributeDto)

List of Custom Attributes

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "groupUuid": "string",
  • "certificateData": "string",
  • "certificateUuid": "string",
  • "customAttributes": [
    ]
}

Response samples

Content type
application/json
{
  • "uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
  • "username": "user1",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "description": "string",
  • "groupName": "string",
  • "groupUuid": "string",
  • "enabled": true,
  • "systemUser": true,
  • "certificate": {
    },
  • "roles": [
    ],
  • "customAttributes": [
    ]
}

Delete User

path Parameters
userUuid
required
string

User UUID

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "code": "string",
  • "message": "string"
}

Add role to User

path Parameters
userUuid
required
string

User UUID

roleUuid
required
string

Role UUID

Responses

Response samples

Content type
application/json
{
  • "uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
  • "username": "user1",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "description": "string",
  • "groupName": "string",
  • "groupUuid": "string",
  • "enabled": true,
  • "systemUser": true,
  • "certificate": {
    },
  • "roles": [
    ],
  • "customAttributes": [
    ]
}

Remove role from User

path Parameters
userUuid
required
string

User UUID

roleUuid
required
string

Role UUID

Responses

Response samples

Content type
application/json
{
  • "uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
  • "username": "user1",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "description": "string",
  • "groupName": "string",
  • "groupUuid": "string",
  • "enabled": true,
  • "systemUser": true,
  • "certificate": {
    },
  • "roles": [
    ],
  • "customAttributes": [
    ]
}

List Users

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create User

Request Body schema: application/json
username
required
string

Username of the user

description
string

Description of the user

firstName
string

First name of the user

lastName
string

Last name of the user

email
string

Email of the user

groupUuid
string

Group UUID of the user

enabled
boolean

Status of the user. True = Enabled, False = Disabled

certificateData
string

Base64 Content of the user certificate

certificateUuid
string

UUID of the existing certificate in the Inventory

Array of objects (RequestAttributeDto)

List of Custom Attributes

Responses

Request samples

Content type
application/json
{
  • "username": "user1",
  • "description": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "groupUuid": "string",
  • "enabled": true,
  • "certificateData": "string",
  • "certificateUuid": "string",
  • "customAttributes": [
    ]
}

Response samples

Content type
application/json
{
  • "uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
  • "username": "user1",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "description": "string",
  • "groupName": "string",
  • "groupUuid": "string",
  • "enabled": true,
  • "systemUser": true,
  • "certificate": {
    },
  • "roles": [
    ],
  • "customAttributes": [
    ]
}

Identify User

Request Body schema: application/json
certificateContent
string

Base64 Content of the certificate

authenticationToken
string

Authentication Token

Responses

Request samples

Content type
application/json
{
  • "certificateContent": "string",
  • "authenticationToken": "string"
}

Response samples

Content type
application/json
{
  • "uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
  • "username": "user1",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "description": "string",
  • "groupName": "string",
  • "groupUuid": "string",
  • "enabled": true,
  • "systemUser": true,
  • "certificate": {
    },
  • "roles": [
    ],
  • "customAttributes": [
    ]
}

Get User Roles

path Parameters
userUuid
required
string

User UUID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add roles to User

path Parameters
userUuid
required
string

User UUID

Request Body schema: application/json

Role UUIDs

Array
string

Responses

Request samples

Content type
application/json
[
  • "c2f685d4-6a3e-11ec-90d6-0242ac120003",
  • "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

Content type
application/json
{
  • "uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
  • "username": "user1",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "description": "string",
  • "groupName": "string",
  • "groupUuid": "string",
  • "enabled": true,
  • "systemUser": true,
  • "certificate": {
    },
  • "roles": [
    ],
  • "customAttributes": [
    ]
}

Enable User

path Parameters
userUuid
required
string

User UUID

Responses

Response samples

Content type
application/json
{
  • "uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
  • "username": "user1",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "description": "string",
  • "groupName": "string",
  • "groupUuid": "string",
  • "enabled": true,
  • "systemUser": true,
  • "certificate": {
    },
  • "roles": [
    ],
  • "customAttributes": [
    ]
}

Disable User

path Parameters
userUuid
required
string

User UUID

Responses

Response samples

Content type
application/json
{
  • "uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
  • "username": "user1",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "description": "string",
  • "groupName": "string",
  • "groupUuid": "string",
  • "enabled": true,
  • "systemUser": true,
  • "certificate": {
    },
  • "roles": [
    ],
  • "customAttributes": [
    ]
}

Get User permissions

path Parameters
userUuid
required
string

User UUID

Responses

Response samples

Content type
application/json
{
  • "allowAllResources": true,
  • "resources": [
    ]
}

Token Instance Controller

Token Instance Controller API

Get Token Instance Detail

path Parameters
uuid
required
string

UUID of the Token Instance

Responses

Response samples

Content type
application/json
{
  • "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
  • "name": "Name",
  • "connectorName": "string",
  • "connectorUuid": "string",
  • "kind": "string",
  • "status": {
    },
  • "tokenProfiles": 0,
  • "attributes": [
    ],
  • "metadata": [
    ],
  • "customAttributes": [
    ]
}

Update Token Instance

path Parameters
uuid
required
string

Token Instance UUID

Request Body schema: application/json
name
required
string

Name of the Token Instance

description
string

Token Instance description

connectorUuid
required
string

UUID of the Connector

kind
required
string

Connector Kind

required
Array of objects (RequestAttributeDto)

Custom Attributes

required
Array of objects (RequestAttributeDto)

Attributes for Token Instance

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "connectorUuid": "string",
  • "kind": "string",
  • "customAttributes": [
    ],
  • "attributes": [
    ]
}

Response samples

Content type
application/json
{
  • "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
  • "name": "Name",
  • "connectorName": "string",
  • "connectorUuid": "string",
  • "kind": "string",
  • "status": {
    },
  • "tokenProfiles": 0,
  • "attributes": [
    ],
  • "metadata": [
    ],
  • "customAttributes": [
    ]
}

deleteTokenInstance

Delete Token Instance

path Parameters
uuid
required
string

Token Instance UUID

Responses

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Reload Token Instance status

path Parameters
uuid
required
string

UUID of the Token Instance

Responses

Response samples

Content type
application/json
{
  • "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
  • "name": "Name",
  • "connectorName": "string",
  • "connectorUuid": "string",
  • "kind": "string",
  • "status": {
    },
  • "tokenProfiles": 0,
  • "attributes": [
    ],
  • "metadata": [
    ],
  • "customAttributes": [
    ]
}

List Token Instances

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new Token Instance

Request Body schema: application/json
name
required
string

Name of the Token Instance

description
string

Token Instance description

connectorUuid
required
string

UUID of the Connector

kind
required
string

Connector Kind

required
Array of objects (RequestAttributeDto)

Custom Attributes

required
Array of objects (RequestAttributeDto)

Attributes for Token Instance

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "connectorUuid": "string",
  • "kind": "string",
  • "customAttributes": [
    ],
  • "attributes": [
    ]
}

Response samples

Content type
application/json
{
  • "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
  • "name": "Name",
  • "connectorName": "string",
  • "connectorUuid": "string",
  • "kind": "string",
  • "status": {
    },
  • "tokenProfiles": 0,
  • "attributes": [
    ],
  • "metadata": [
    ],
  • "customAttributes": [
    ]
}

Deactivate Token Instance

path Parameters
uuid
required
string

Token Instance UUID

Responses

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Activate Token Instance

path Parameters
uuid
required
string

Token Instance UUID

Request Body schema: application/json
Array
uuid
required
string

UUID of the Attribute

name
required
string

Name of the Attribute

contentType
required
string (AttributeContentType)
Enum: "string" "text" "integer" "boolean" "float" "date" "time" "datetime" "secret" "file" "credential" "codeblock" "object"

Type of the attribute content.

required
Array of BooleanAttributeContent (object) or CodeBlockAttributeContent (object) or CredentialAttributeContent (object) or DateAttributeContent (object) or DateTimeAttributeContent (object) or FileAttributeContent (object) or FloatAttributeContent (object) or IntegerAttributeContent (object) or ObjectAttributeContent (object) or SecretAttributeContent (object) or StringAttributeContent (object) or TextAttributeContent (object) or TimeAttributeContent (object) (BaseAttributeContentDto)

Content of the Attribute

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "message": "Error message"
}

List Token Profile Attributes

path Parameters
uuid
required
string

Token instance UUID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List Token activation Attributes

path Parameters
uuid
required
string

Token Instance UUID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

deleteTokenInstance_1

Delete multiple Token Instance

Request Body schema: application/json

Token Instance UUIDs

Array
string

Responses

Request samples

Content type
application/json
[
  • "c2f685d4-6a3e-11ec-90d6-0242ac120003",
  • "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Authentication Management

Authentication Management API

Profile Authorization

Responses

Response samples

Content type
application/json
{
  • "uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
  • "username": "user1",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "description": "string",
  • "groupName": "string",
  • "groupUuid": "string",
  • "enabled": true,
  • "systemUser": true,
  • "certificate": {
    },
  • "roles": [
    ],
  • "customAttributes": [
    ]
}

Update User Profile

Request Body schema: application/json
description
string

Description of the user

firstName
string

First name of the user

lastName
string

Last name of the user

email
required
string

Email of the user

groupUuid
string

Group UUID of the user

certificateData
string

Base64 Content of the admin certificate

certificateUuid
string

UUID of the existing certificate in the Inventory. Mandatory if certificate is not provided

Array of objects (RequestAttributeDto)

List of Custom Attributes

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "groupUuid": "string",
  • "certificateData": "string",
  • "certificateUuid": "string",
  • "customAttributes": [
    ]
}

Response samples

Content type
application/json
{
  • "uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
  • "username": "user1",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "description": "string",
  • "groupName": "string",
  • "groupUuid": "string",
  • "enabled": true,
  • "systemUser": true,
  • "certificate": {
    },
  • "roles": [
    ],
  • "customAttributes": [
    ]
}

Get Auth Resources

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get List of objects for Object Access

path Parameters
resourceName
required
string (Resource)
Enum: "NONE" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "notificationInstances" "users" "roles" "acmeAccounts" "acmeProfiles" "scepProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals"

Resource Name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Scheduled Jobs Management

Scheduled Jobs Management API

Enabling of Scheduled job

path Parameters
uuid
required
string

Scheduled job UUID

Responses

Disabling of Scheduled job

path Parameters
uuid
required
string

Scheduled job UUID

Responses

List of scheduled jobs

query Parameters
required
object (PaginationRequestDto)

Responses

Response samples

Content type
application/json
{
  • "itemsPerPage": 0,
  • "pageNumber": 0,
  • "totalPages": 0,
  • "totalItems": 0,
  • "scheduledJobs": [
    ]
}

Scheduled job detail

path Parameters
uuid
required
string

Scheduled job UUID

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "jobName": "string",
  • "jobType": "string",
  • "cronExpression": "string",
  • "enabled": true,
  • "oneTime": true,
  • "system": true,
  • "lastExecutionStatus": "started",
  • "userUuid": "dcbf2986-7a6c-4291-9074-6441a23e4826",
  • "objectData": { }
}

Delete Scheduled job

path Parameters
uuid
required
string

Scheduled job UUID

Responses

Scheduled job history

path Parameters
uuid
required
string

Scheduled job UUID

query Parameters
required
object (PaginationRequestDto)

Responses

Response samples

Content type
application/json
{
  • "itemsPerPage": 0,
  • "pageNumber": 0,
  • "totalPages": 0,
  • "totalItems": 0,
  • "scheduledJobHistory": [
    ]
}

Client Operations v2

Client Operations v2 API

Issue Certificate

path Parameters
authorityUuid
required
string

Authority Instance UUID

raProfileUuid
required
string

RA Profile UUID

Request Body schema: application/json
Array of objects (RequestAttributeDto)

List of attributes to create CSR. Required if CSR is not provided

Array of objects (RequestAttributeDto)

List of attributes to sign the CSR

request
required
string

Certificate signing request encoded as Base64 string

format
string (CertificateRequestFormat)
Default: "pkcs10"
Enum: "pkcs10" "crmf"

Certificate signing request format

tokenProfileUuid
string <uuid>

Token Profile UUID. Required if CSR is not uploaded

keyUuid
string <uuid>

Key UUID. Required if CSR is not uploaded

required
Array of objects (RequestAttributeDto)

List of RA Profile related Attributes to issue Certificate

Array of objects (RequestAttributeDto)

List of Custom Attributes

Responses

Request samples

Content type
application/json
{
  • "csrAttributes": [
    ],
  • "signatureAttributes": [
    ],
  • "request": "string",
  • "format": "pkcs10",
  • "tokenProfileUuid": "66f2e24c-4f07-496b-b5c4-6fe8a5e8361a",
  • "keyUuid": "a0e39a6c-fae3-43d6-99c3-a3620775a368",
  • "attributes": [
    ],
  • "customAttributes": [
    ]
}

Response samples

Content type
application/json
{
  • "certificateData": "string",
  • "uuid": "string"
}

Revoke Certificate

path Parameters
authorityUuid
required
string

Authority Instance UUID

raProfileUuid
required
string

RA Profile UUID

certificateUuid
required
string

Certificate UUID

Request Body schema: application/json
reason
string (CertificateRevocationReason)
Default: "UNSPECIFIED"
Enum: "unspecified" "keyCompromise" "cACompromise" "affiliationChanged" "superseded" "cessationOfOperation" "certificateHold" "privilegeWithdrawn" "aACompromise"

Reason for revocation

required
Array of objects (RequestAttributeDto)

List of Attributes to revoke Certificate

destroyKey
boolean
Default: false

Destroy Key upon successful revocation

Responses

Request samples

Content type
application/json
{
  • "reason": "unspecified",
  • "attributes": [
    ],
  • "destroyKey": false
}

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Renew Certificate

path Parameters
authorityUuid
required
string

Authority Instance UUID

raProfileUuid
required
string

RA Profile UUID

certificateUuid
required
string

Certificate UUID

Request Body schema: application/json
replaceInLocations
boolean
Default: false

True to replace renewed certificate in the associated locations

request
string

Certificate signing request encoded as Base64 string. If not provided, Existing CSR will be used

format
string (CertificateRequestFormat)
Default: "pkcs10"
Enum: "pkcs10" "crmf"

Certificate signing request format

Responses

Request samples

Content type
application/json
{
  • "replaceInLocations": false,
  • "request": "string",
  • "format": "pkcs10"
}

Response samples

Content type
application/json
{
  • "certificateData": "string",
  • "uuid": "string"
}

Rekey Certificate

path Parameters
authorityUuid
required
string

Authority Instance UUID

raProfileUuid
required
string

RA Profile UUID

certificateUuid
required
string

Certificate UUID

Request Body schema: application/json
replaceInLocations
boolean
Default: false

True to replace renewed certificate in the associated locations

request
string

Certificate signing request encoded as Base64 string. If not provided, CSR attributes will be used

format
string (CertificateRequestFormat)
Default: "pkcs10"
Enum: "pkcs10" "crmf"

Certificate signing request format

keyUuid
required
string <uuid>

Key UUID

tokenProfileUuid
required
string <uuid>

Token Profile UUID

Array of objects (RequestAttributeDto)

Signature Attributes. If not provided, existing attributes will be used to generate the new CSR

Responses

Request samples

Content type
application/json
{
  • "replaceInLocations": false,
  • "request": "string",
  • "format": "pkcs10",
  • "keyUuid": "a0e39a6c-fae3-43d6-99c3-a3620775a368",
  • "tokenProfileUuid": "66f2e24c-4f07-496b-b5c4-6fe8a5e8361a",
  • "signatureAttributes": [
    ]
}

Response samples

Content type
application/json
{
  • "certificateData": "string",
  • "uuid": "string"
}

Issue existing certificate with status New

path Parameters
authorityUuid
required
string

Authority Instance UUID

raProfileUuid
required
string

RA Profile UUID

certificateUuid
required
string

Certificate UUID

Responses

Response samples

Content type
application/json
{
  • "certificateData": "string",
  • "uuid": "string"
}

Validate revocation Attributes

path Parameters
authorityUuid
required
string

Authority Instance UUID

raProfileUuid
required
string

RA Profile UUID

Request Body schema: application/json
Array
uuid
required
string

UUID of the Attribute

name
required
string

Name of the Attribute

contentType
required
string (AttributeContentType)
Enum: "string" "text" "integer" "boolean" "float" "date" "time" "datetime" "secret" "file" "credential" "codeblock" "object"

Type of the attribute content.

required
Array of BooleanAttributeContent (object) or CodeBlockAttributeContent (object) or CredentialAttributeContent (object) or DateAttributeContent (object) or DateTimeAttributeContent (object) or FileAttributeContent (object) or FloatAttributeContent (object) or IntegerAttributeContent (object) or ObjectAttributeContent (object) or SecretAttributeContent (object) or StringAttributeContent (object) or TextAttributeContent (object) or TimeAttributeContent (object) (BaseAttributeContentDto)

Content of the Attribute

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Validate issue Certificate Attributes

path Parameters
authorityUuid
required
string

Authority Instance UUID

raProfileUuid
required
string

RA Profile UUID

Request Body schema: application/json
Array
uuid
required
string

UUID of the Attribute

name
required
string

Name of the Attribute

contentType
required
string (AttributeContentType)
Enum: "string" "text" "integer" "boolean" "float" "date" "time" "datetime" "secret" "file" "credential" "codeblock" "object"

Type of the attribute content.

required
Array of BooleanAttributeContent (object) or CodeBlockAttributeContent (object) or CredentialAttributeContent (object) or DateAttributeContent (object) or DateTimeAttributeContent (object) or FileAttributeContent (object) or FloatAttributeContent (object) or IntegerAttributeContent (object) or ObjectAttributeContent (object) or SecretAttributeContent (object) or StringAttributeContent (object) or TextAttributeContent (object) or TimeAttributeContent (object) (BaseAttributeContentDto)

Content of the Attribute

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Get revocation Attributes

path Parameters
authorityUuid
required
string

Authority Instance UUID

raProfileUuid
required
string

RA Profile UUID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get issue Certificate Attributes

path Parameters
authorityUuid
required
string

Authority Instance UUID

raProfileUuid
required
string

RA Profile UUID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Global Metadata

Global Metadata API

Global Metadata details

path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "contentType": "string",
  • "description": "string",
  • "enabled": true,
  • "type": "data",
  • "label": "Attribute Name",
  • "visible": true,
  • "group": "requiredAttributes"
}

Edit Global Metadata

path Parameters
uuid
required
string

Global Metadata UUID

Request Body schema: application/json
description
string

Attribute description

label
required
string

Friendly name of the the Attribute

visible
boolean
Default: true

Boolean determining if the Attribute is visible and can be displayed, otherwise it should be hidden to the user.

group
string

Group of the Attribute, used for the logical grouping of the Attribute

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "label": "Attribute Name",
  • "visible": true,
  • "group": "requiredAttributes"
}

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "contentType": "string",
  • "description": "string",
  • "enabled": true,
  • "type": "data",
  • "label": "Attribute Name",
  • "visible": true,
  • "group": "requiredAttributes"
}

Delete Global Metadata

path Parameters
uuid
required
string

Global Metadata UUID

Responses

Response samples

Content type
application/json
{
  • "message": "Error message"
}

List Global Metadata

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Global Metadata

Request Body schema: application/json
name
required
string

Name of the Attribute

contentType
required
string (AttributeContentType)
Enum: "string" "text" "integer" "boolean" "float" "date" "time" "datetime" "secret" "file" "credential" "codeblock" "object"

Type of the attribute content.

description
string

Attribute description

label
required
string

Friendly name of the the Attribute

visible
boolean
Default: true

Boolean determining if the Attribute is visible and can be displayed, otherwise it should be hidden to the user.

group
string

Group of the Attribute, used for the logical grouping of the Attribute

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "contentType": "string",
  • "description": "string",
  • "label": "Attribute Name",
  • "visible": true,
  • "group": "requiredAttributes"
}

Response samples

Content type
application/json
{
  • "uuid": "string"
}

Delete multiple Global Metadata

Request Body schema: application/json

Global Metadata UUIDs

Array
string

Responses

Request samples

Content type
application/json
[
  • "c2f685d4-6a3e-11ec-90d6-0242ac120003",
  • "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Get Available Connector Metadata

query Parameters
connectorUuid
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Promote Connector Metadata to Global Metadata

Request Body schema: application/json
uuid
required
string

Metadata UUID

connectorUuid
required
string

Connector UUID

Responses

Request samples

Content type
application/json
{
  • "uuid": "string",
  • "connectorUuid": "string"
}

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "contentType": "string",
  • "description": "string",
  • "enabled": true,
  • "type": "data",
  • "label": "Attribute Name",
  • "visible": true,
  • "group": "requiredAttributes"
}

Statistics/Dashboard

Statistics/Dashboard API

Get Dashboard/Statistics Details

Responses

Response samples

Content type
application/json
{
  • "totalCertificates": 0,
  • "totalGroups": 0,
  • "totalDiscoveries": 0,
  • "totalConnectors": 0,
  • "totalRaProfiles": 0,
  • "totalCredentials": 0,
  • "totalAuthorities": 0,
  • "totalAdministrators": 0,
  • "totalClients": 0,
  • "groupStatByCertificateCount": {
    },
  • "raProfileStatByCertificateCount": {
    },
  • "certificateStatByType": {
    },
  • "certificateStatByExpiry": {
    },
  • "certificateStatByKeySize": {
    },
  • "certificateStatByBasicConstraints": {
    },
  • "certificateStatByState": {
    },
  • "certificateStatByValidationStatus": {
    },
  • "certificateStatByComplianceStatus": {
    },
  • "connectorStatByStatus": {
    },
  • "raProfileStatByStatus": {
    },
  • "administratorStatByStatus": {
    },
  • "clientStatByStatus": {
    }
}

Local operations

API only accessible from localhost

Create Administrator

Request Body schema: application/json
username
required
string

Username of the user

description
string

Description of the user

firstName
string

First name of the user

lastName
string

Last name of the user

email
string

Email of the user

groupUuid
string

Group UUID of the user

enabled
boolean

Status of the user. True = Enabled, False = Disabled

certificateData
string

Base64 Content of the user certificate

certificateUuid
string

UUID of the existing certificate in the Inventory

Array of objects (RequestAttributeDto)

List of Custom Attributes

Responses

Request samples

Content type
application/json
{
  • "username": "user1",
  • "description": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "groupUuid": "string",
  • "enabled": true,
  • "certificateData": "string",
  • "certificateUuid": "string",
  • "customAttributes": [
    ]
}

Response samples

Content type
application/json
{
  • "uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
  • "username": "user1",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "description": "string",
  • "groupName": "string",
  • "groupUuid": "string",
  • "enabled": true,
  • "systemUser": true,
  • "certificate": {
    },
  • "roles": [
    ],
  • "customAttributes": [
    ]
}

Credential Management

Credential Management API

Details of a Credentials

path Parameters
uuid
required
string

Credential UUID

Responses

Response samples

Content type
application/json
{
  • "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
  • "name": "Name",
  • "kind": "SoftKeyStore, Basic, ApiKey, etc",
  • "attributes": [
    ],
  • "customAttributes": [
    ],
  • "enabled": true,
  • "connectorUuid": "string",
  • "connectorName": "string"
}

Edit Credential

path Parameters
uuid
required
string

Credential UUID

Request Body schema: application/json
required
Array of objects (RequestAttributeDto)

List of Credential Attributes

Array of objects (RequestAttributeDto)

List of Custom Attributes

Responses

Request samples

Content type
application/json
{
  • "attributes": [
    ],
  • "customAttributes": [
    ]
}

Response samples

Content type
application/json
{
  • "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
  • "name": "Name",
  • "kind": "SoftKeyStore, Basic, ApiKey, etc",
  • "attributes": [
    ],
  • "customAttributes": [
    ],
  • "enabled": true,
  • "connectorUuid": "string",
  • "connectorName": "string"
}

Delete Credential

path Parameters
uuid
required
string

Credential UUID

Responses

Response samples

Content type
application/json
{
  • "message": "Error message"
}

List of All Credentials

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add Credential

Request Body schema: application/json
name
required
string

Credential name

kind
required
string

Credential Kind

required
Array of objects (RequestAttributeDto)

List of Credential Attributes

Array of objects (RequestAttributeDto)

List of Custom Attributes

connectorUuid
required
string

UUID of Credential provider Connector

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "kind": "SoftKeyStore, Basic, ApiKey, etc",
  • "attributes": [
    ],
  • "customAttributes": [
    ],
  • "connectorUuid": "string"
}

Response samples

Content type
application/json
{
  • "uuid": "string"
}

Delete multiple Credentials

Request Body schema: application/json

Credential UUIDs

Array
string

Responses

Request samples

Content type
application/json
[
  • "c2f685d4-6a3e-11ec-90d6-0242ac120003",
  • "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Enable Credential

path Parameters
uuid
required
string

Credential UUID

Responses

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Disable Credential

path Parameters
uuid
required
string

Credential UUID

Responses

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Callback

Callback API

Resource Callback API

API to trigger the Callback for resource.

path Parameters
resource
required
string (Resource)
Enum: "NONE" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "notificationInstances" "users" "roles" "acmeAccounts" "acmeProfiles" "scepProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals"

Name of the resource

parentObjectUuid
required
string

Parent Object UUID

Request Body schema: application/json
uuid
string

UUID of the Attribute

name
required
string

Name of the Attribute

object

Map of path variables supported by the callback method

object

Map of the query parameters supported by the callback method

object

Request body for the callback method

Responses

Request samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "pathVariable": {
    },
  • "requestParameter": {
    },
  • "body": {
    }
}

Response samples

Content type
application/json
{ }

Connector Callback API

API to trigger the Callback for Connector.

path Parameters
uuid
required
string

Connector UUID

functionGroup
required
string

Function Group

kind
required
string

Kind

Request Body schema: application/json
uuid
string

UUID of the Attribute

name
required
string

Name of the Attribute

object

Map of path variables supported by the callback method

object

Map of the query parameters supported by the callback method

object

Request body for the callback method

Responses

Request samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "pathVariable": {
    },
  • "requestParameter": {
    },
  • "body": {
    }
}

Response samples

Content type
application/json
{ }

Cryptographic Key Controller

Cryptographic Key Controller API

Get Cryptographic Key Detail

path Parameters
tokenInstanceUuid
required
string

UUID of the Token Instance

uuid
required
string

UUID of the Key

Responses

Response samples

Content type
application/json
{
  • "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
  • "name": "Name",
  • "description": "string",
  • "creationTime": "2019-08-24T14:15:22Z",
  • "tokenProfileUuid": "string",
  • "tokenProfileName": "string",
  • "tokenInstanceUuid": "string",
  • "tokenInstanceName": "string",
  • "customAttributes": [
    ],
  • "attributes": [
    ],
  • "owner": "string",
  • "ownerUuid": "string",
  • "group": {
    },
  • "items": [
    ],
  • "associations": [
    ]
}

Edit Key

path Parameters
tokenInstanceUuid
required
string

Token Instance UUID

uuid
required
string

Key UUID

Request Body schema: application/json
tokenProfileUuid
required
string

UUID of the token profile

name
required
string

Name of the Cryptographic Key

description
required
string

Description of the Cryptographic Key

ownerUuid
string

Key Owner UUID

groupUuid
string

UUID of the group

Array of objects (RequestAttributeDto)

List of Custom Attributes

Responses

Request samples

Content type
application/json
{
  • "tokenProfileUuid": "string",
  • "name": "string",
  • "description": "string",
  • "ownerUuid": "string",
  • "groupUuid": "string",
  • "customAttributes": [
    ]
}

Response samples

Content type
application/json
{
  • "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
  • "name": "Name",
  • "description": "string",
  • "creationTime": "2019-08-24T14:15:22Z",
  • "tokenProfileUuid": "string",
  • "tokenProfileName": "string",
  • "tokenInstanceUuid": "string",
  • "tokenInstanceName": "string",
  • "customAttributes": [
    ],
  • "attributes": [
    ],
  • "owner": "string",
  • "ownerUuid": "string",
  • "group": {
    },
  • "items": [
    ],
  • "associations": [
    ]
}

Delete Cryptographic Key

If the request body provided, only those key items will be deleted. If the request body is not provided or given empty, then the entire key will be destroyed

path Parameters
tokenInstanceUuid
required
string

Token Instance UUID

uuid
required
string

Key UUID

Request Body schema: application/json

Key Item UUIDs

Array
string

Responses

Request samples

Content type
application/json
[
  • "c2f685d4-6a3e-11ec-90d6-0242ac120003",
  • "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Update Key Usage

If the request body provided, only those key items will be updated. If the request body is not provided or given empty, then the entire key will be updated

path Parameters
tokenInstanceUuid
required
string

Token Instance UUID

uuid
required
string

Key UUID

Request Body schema: application/json
usage
required
Array of strings (KeyUsage)
Items Enum: "sign" "verify" "encrypt" "decrypt" "wrap" "unwrap"

Usages for the Key

uuids
Array of strings <uuid>

List of UUIDs of the key Items. If not provided, the usage will be updated to all the itemsin the key

Responses

Request samples

Content type
application/json
{
  • "usage": [
    ],
  • "uuids": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Update Key Usages for Multiple Keys

Update the key usages for multiple keys and all the items inside it

Request Body schema: application/json
usage
required
Array of strings (KeyUsage)
Items Enum: "sign" "verify" "encrypt" "decrypt" "wrap" "unwrap"

Usages for the Key

uuids
required
Array of strings <uuid>

Key UUIDs

Responses

Request samples

Content type
application/json
{
  • "usage": [
    ],
  • "uuids": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Update Key Usages for Multiple Key Items

Update the key usages for multiple keys Items

Request Body schema: application/json
usage
required
Array of strings (KeyUsage)
Items Enum: "sign" "verify" "encrypt" "decrypt" "wrap" "unwrap"

Usages for the Key

uuids
required
Array of strings <uuid>

Key Item UUIDs

Responses

Request samples

Content type
application/json
{
  • "usage": [
    ],
  • "uuids": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Create a new Cryptographic Key

path Parameters
tokenInstanceUuid
required
string

UUID of the Token Instance

tokenProfileUuid
required
string

UUID of the Token Profile

type
required
string (KeyRequestType)
Enum: "secret" "keyPair"

Type of the key to be created

Request Body schema: application/json
name
required
string

Name of the Cryptographic Key

description
required
string

Description of the Cryptographic Key

groupUuid
string

UUID of the group

required
Array of objects (RequestAttributeDto)

List of Attributes to create a Key

Array of objects (RequestAttributeDto)

Custom Attributes for the key

enabled
boolean
Default: false

Enabled status of created key. True = Enabled, False = Disabled

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "groupUuid": "string",
  • "attributes": [
    ],
  • "customAttributes": [
    ],
  • "enabled": false
}

Response samples

Content type
application/json
{
  • "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
  • "name": "Name",
  • "description": "string",
  • "creationTime": "2019-08-24T14:15:22Z",
  • "tokenProfileUuid": "string",
  • "tokenProfileName": "string",
  • "tokenInstanceUuid": "string",
  • "tokenInstanceName": "string",
  • "customAttributes": [
    ],
  • "attributes": [
    ],
  • "owner": "string",
  • "ownerUuid": "string",
  • "group": {
    },
  • "items": [
    ],
  • "associations": [
    ]
}

List cryptographic keys

Request Body schema: application/json
Array of objects (SearchFilterRequestDto)

Certificate filter input

itemsPerPage
integer <int32> <= 1000
Default: 10

Number of entries per page

pageNumber
integer <int32>
Default: 1

Page number for the request

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ],
  • "itemsPerPage": 10,
  • "pageNumber": 1
}

Response samples

Content type
application/json
{
  • "cryptographicKeys": [
    ],
  • "itemsPerPage": 0,
  • "pageNumber": 0,
  • "totalPages": 0,
  • "totalItems": 0
}

Delete Multiple Cryptographic Key

Request Body schema: application/json

Key UUIDs

Array
string

Responses

Request samples

Content type
application/json
[
  • "c2f685d4-6a3e-11ec-90d6-0242ac120003",
  • "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Sync Keys from connector

path Parameters
tokenInstanceUuid
required
string

Token Instance UUID

Responses

Enable Key

If the request body provided, only those key items will be enabled. If the request body is not provided or given empty, then the entire key will be enabled

path Parameters
tokenInstanceUuid
required
string

Token Instance UUID

uuid
required
string

Key UUID

Request Body schema: application/json

Key Item UUIDs

Array
string

Responses

Request samples

Content type
application/json
[
  • "c2f685d4-6a3e-11ec-90d6-0242ac120003",
  • "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Disable Key

If the request body provided, only those key items will be disabled. If the request body is not provided or given empty, then the entire key will be disabled

path Parameters
tokenInstanceUuid
required
string

Token Instance UUID

uuid
required
string

Key UUID

Request Body schema: application/json

Key Item UUIDs

Array
string

Responses

Request samples

Content type
application/json
[
  • "c2f685d4-6a3e-11ec-90d6-0242ac120003",
  • "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Destroy Cryptographic Key

If the request body provided, only those key items will be destroyed. If the request body is not provided or given empty, then the entire key will be destroyed

path Parameters
tokenInstanceUuid
required
string

Token Instance UUID

uuid
required
string

Key UUID

Request Body schema: application/json

Key UUIDs

Array
string

Responses

Request samples

Content type
application/json
[
  • "c2f685d4-6a3e-11ec-90d6-0242ac120003",
  • "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Mark Key and its Items as Compromised

If the request body is provided with the UUID of the items of Key, then only those itemswill be compromised. Else all the sub items of the key will be compromised

path Parameters
tokenInstanceUuid
required
string

Token Instance UUID

uuid
required
string

Key UUID

Request Body schema: application/json
reason
required
string (KeyCompromiseReason)
Enum: "disclosure" "modification" "substitution" "use_of_sensitive_data"

Reason for Compromise

uuids
Array of strings <uuid>

List of UUIDs of the key Items. If not provided, the usage will be updated to all the itemsin the key

Responses

Request samples

Content type
application/json
{
  • "reason": "disclosure",
  • "uuids": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Enable multiple Key Items

Request Body schema: application/json

Key Item UUIDs

Array
string

Responses

Request samples

Content type
application/json
[
  • "c2f685d4-6a3e-11ec-90d6-0242ac120003",
  • "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Disable multiple Key Items

Request Body schema: application/json

Key Item UUIDs

Array
string

Responses

Request samples

Content type
application/json
[
  • "c2f685d4-6a3e-11ec-90d6-0242ac120003",
  • "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Destroy Multiple Cryptographic Key items

Request Body schema: application/json

Key Item UUIDs

Array
string

Responses

Request samples

Content type
application/json
[
  • "c2f685d4-6a3e-11ec-90d6-0242ac120003",
  • "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Mark Multiple Key Items as Compromised

This API can be used to mark multiple keys items to be marked as compromised.

Request Body schema: application/json
reason
required
string (KeyCompromiseReason)
Enum: "disclosure" "modification" "substitution" "use_of_sensitive_data"

Reason for Compromise

uuids
Array of strings <uuid>

List of Key Item UUID

Responses

Request samples

Content type
application/json
{
  • "reason": "disclosure",
  • "uuids": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Enable multiple Keys

Request Body schema: application/json

Key UUIDs

Array
string

Responses

Request samples

Content type
application/json
[
  • "c2f685d4-6a3e-11ec-90d6-0242ac120003",
  • "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Disable multiple Keys

Request Body schema: application/json

Key UUIDs

Array
string

Responses

Request samples

Content type
application/json
[
  • "c2f685d4-6a3e-11ec-90d6-0242ac120003",
  • "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Destroy Multiple Cryptographic Key and its items

Request Body schema: application/json

Key UUIDs

Array
string

Responses

Request samples

Content type
application/json
[
  • "c2f685d4-6a3e-11ec-90d6-0242ac120003",
  • "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Mark Multiple Key and all its Items as Compromised

This API can be used to mark multiple keys and its sub items to be marked as compromised.Specific part of the key cannot be mentioned in this API

Request Body schema: application/json
reason
required
string (KeyCompromiseReason)
Enum: "disclosure" "modification" "substitution" "use_of_sensitive_data"

Reason for Compromise

uuids
Array of strings <uuid>

List of UUIDs of the keys. This will mark all the items inside the selected key as compromised

Responses

Request samples

Content type
application/json
{
  • "reason": "disclosure",
  • "uuids": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Error message"
}

List of Attributes to create a Key

path Parameters
tokenInstanceUuid
required
string

Token Instance UUID

tokenProfileUuid
required
string

Token Profile UUID

type
required
string (KeyRequestType)
Enum: "secret" "keyPair"

Type of the key to be created

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Cryptographic Key Detail

path Parameters
tokenInstanceUuid
required
string

UUID of the Token Instance

uuid
required
string

UUID of the Key

keyItemUuid
required
string

UUID of the Key Item

Responses

Response samples

Content type
application/json
{
  • "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
  • "name": "Name",
  • "keyReferenceUuid": "string",
  • "type": "Secret",
  • "keyAlgorithm": "RSA",
  • "format": "Raw",
  • "keyData": "string",
  • "length": 0,
  • "metadata": [
    ],
  • "usage": [
    ],
  • "enabled": true,
  • "state": "pre-active",
  • "reason": "disclosure"
}

Get Key Item event history

path Parameters
tokenInstanceUuid
required
string

Token Instance UUID

uuid
required
string

Key UUID

keyItemUuid
required
string

Key Item UUID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get CryptographicKey searchable fields information

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List Cryptographic Keys with full Key Pairs

This API contains the logic to get the keys that contains the full key pair (private and public Key)

query Parameters
tokenProfileUuid
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete Multiple Cryptographic Key Items

Request Body schema: application/json

Key Items UUIDs

Array
string

Responses

Request samples

Content type
application/json
[
  • "c2f685d4-6a3e-11ec-90d6-0242ac120003",
  • "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

Content type
application/json
{
  • "message": "Error message"
}

External Notification Management

External Notification Management API for managing notification instances that can be used to notify recipient(s) about events that were triggered in the platform. Note that this API does not handle internal notifications. For internal notifications, please refer to the Internal Notification API

Details of an Notification instance

path Parameters
uuid
required
string

Notification instance UUID

Responses

Response samples

Content type
application/json
{
  • "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
  • "name": "Name",
  • "description": "string",
  • "connectorUuid": "string",
  • "connectorName": "string",
  • "kind": "string",
  • "attributes": [
    ],
  • "attributeMappings": [
    ]
}

Edit Notification instance

path Parameters
uuid
required
string

Notification instance UUID

Request Body schema: application/json
description
string

Notification instance description

required
Array of objects (RequestAttributeDto)

List of Notification instance Attributes

Array of objects (AttributeMappingDto)

List of attribute mappings between mapping attributes and (recipient) custom attributes

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "attributes": [
    ],
  • "attributeMappings": [
    ]
}

Response samples

Content type
application/json
{
  • "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
  • "name": "Name",
  • "description": "string",
  • "connectorUuid": "string",
  • "connectorName": "string",
  • "kind": "string",
  • "attributes": [
    ],
  • "attributeMappings": [
    ]
}

Delete Notification instance

path Parameters
uuid
required
string

Notification instance UUID

Responses

Response samples

Content type
application/json
{
  • "message": "Error message"
}

List of available Notification instances

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add Notification instance

Request Body schema: application/json
description
string

Notification instance description

required
Array of objects (RequestAttributeDto)

List of Notification instance Attributes

Array of objects (AttributeMappingDto)

List of attribute mappings between mapping attributes and (recipient) custom attributes

name
required
string

Notification instance name

connectorUuid
required
string

UUID of Notification provider

kind
required
string

Notification instance Kind

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "attributes": [
    ],
  • "attributeMappings": [
    ],
  • "name": "string",
  • "connectorUuid": "string",
  • "kind": "string"
}

Response samples

Content type
application/json
{
  • "uuid": "string"
}

List of mapping attributes

path Parameters
connectorUuid
required
string

Connector UUID

kind
required
string

Kind

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Location Management

Location Management API

Get Location Details

path Parameters
entityUuid
required
string

Entity UUID

locationUuid
required
string

Location UUID

Responses

Response samples

Content type
application/json
{
  • "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
  • "name": "Name",
  • "description": "string",
  • "entityInstanceUuid": "string",
  • "entityInstanceName": "string",
  • "attributes": [
    ],
  • "customAttributes": [
    ],
  • "enabled": true,
  • "supportMultipleEntries": false,
  • "supportKeyManagement": false,
  • "certificates": [
    ],
  • "metadata": [
    ]
}

Edit Location

path Parameters
entityUuid
required
string

Entity UUID

locationUuid
required
string

Location UUID

Request Body schema: application/json
description
string

Description of the Location

required
Array of objects (RequestAttributeDto)

List of Attributes for Location

Array of objects (RequestAttributeDto)

List of Custom Attributes

enabled
boolean

Enabled flag - true = enabled; false = disabled

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "attributes": [
    ],
  • "customAttributes": [
    ],
  • "enabled": true
}

Response samples

Content type
application/json
{
  • "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
  • "name": "Name",
  • "description": "string",
  • "entityInstanceUuid": "string",
  • "entityInstanceName": "string",
  • "attributes": [
    ],
  • "customAttributes": [
    ],
  • "enabled": true,
  • "supportMultipleEntries": false,
  • "supportKeyManagement": false,
  • "certificates": [
    ],
  • "metadata": [
    ]
}

Delete Location

path Parameters
entityUuid
required
string

Entity UUID

locationUuid
required
string

Location UUID

Responses

Sync Location content

path Parameters
entityUuid
required
string

Entity UUID

locationUuid
required
string

Location UUID

Responses

Response samples

Content type
application/json
{
  • "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
  • "name": "Name",
  • "description": "string",
  • "entityInstanceUuid": "string",
  • "entityInstanceName": "string",
  • "attributes": [
    ],
  • "customAttributes": [
    ],
  • "enabled": true,
  • "supportMultipleEntries": false,
  • "supportKeyManagement": false,
  • "certificates": [
    ],
  • "metadata": [
    ]
}

Push Certificate to Location

path Parameters
entityUuid
required
string

Entity UUID

locationUuid
required
string

Location UUID

certificateUuid
required
string

Certificate UUID

Request Body schema: application/json
required
Array of objects (RequestAttributeDto)

List of push Attributes for Location

Responses

Request samples

Content type
application/json
{
  • "attributes": [
    ]
}

Response samples

Content type
application/json
{
  • "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
  • "name": "Name",
  • "description": "string",
  • "entityInstanceUuid": "string",
  • "entityInstanceName": "string",
  • "attributes": [
    ],
  • "customAttributes": [
    ],
  • "enabled": true,
  • "supportMultipleEntries": false,
  • "supportKeyManagement": false,
  • "certificates": [
    ],
  • "metadata": [
    ]
}

Remove Certificate from Location

path Parameters
entityUuid
required
string

Entity UUID

locationUuid
required
string

Location UUID

certificateUuid
required
string

Certificate UUID

Responses

Response samples

Content type
application/json
{
  • "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
  • "name": "Name",
  • "description": "string",
  • "entityInstanceUuid": "string",
  • "entityInstanceName": "string",
  • "attributes": [
    ],
  • "customAttributes": [
    ],
  • "enabled": true,
  • "supportMultipleEntries": false,
  • "supportKeyManagement": false,
  • "certificates": [
    ],
  • "metadata": [
    ]
}

Renew Certificate in Location

path Parameters
entityUuid
required
string

Entity UUID

locationUuid
required
string

Location UUID

certificateUuid
required
string

Certificate UUID

Responses

Response samples

Content type
application/json
{
  • "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
  • "name": "Name",
  • "description": "string",
  • "entityInstanceUuid": "string",
  • "entityInstanceName": "string",
  • "attributes": [
    ],
  • "customAttributes": [
    ],
  • "enabled": true,
  • "supportMultipleEntries": false,
  • "supportKeyManagement": false,
  • "certificates": [
    ],
  • "metadata": [
    ]
}

List Locations

Request Body schema: application/json
Array of objects (SearchFilterRequestDto)

Certificate filter input

itemsPerPage
integer <int32> <= 1000
Default: 10

Number of entries per page

pageNumber
integer <int32>
Default: 1

Page number for the request

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ],
  • "itemsPerPage": 10,
  • "pageNumber": 1
}

Response samples

Content type
application/json
{
  • "locations": [
    ],
  • "itemsPerPage": 0,
  • "pageNumber": 0,
  • "totalPages": 0,
  • "totalItems": 0
}

Add Location

path Parameters
entityUuid
required
string

Entity UUID

Request Body schema: application/json
name
required
string

Location name

description
string

Location description

required
Array of objects (RequestAttributeDto)

List of Attributes to register Location

Array of objects (RequestAttributeDto)

List of Custom Attributes

enabled
boolean
Default: false

Enabled flag - true = enabled; false = disabled

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "attributes": [
    ],
  • "customAttributes": [
    ],
  • "enabled": false
}

Response samples

Content type
application/json
{
  • "uuid": "string"
}

Issue Certificate to Location

path Parameters
entityUuid
required
string

Entity UUID

locationUuid
required
string

Location UUID

Request Body schema: application/json
raProfileUuid
required
string

RA Profile UUID

required
Array of objects (RequestAttributeDto)

List of CSR Attributes for Location

required
Array of objects (RequestAttributeDto)

List of certificate issue Attributes for RA Profile

Array of objects (RequestAttributeDto)

List of Custom Attributes

Array of objects (RequestAttributeDto)

List of Certificate Custom Attributes

Responses

Request samples

Content type
application/json
{
  • "raProfileUuid": "string",
  • "csrAttributes": [
    ],
  • "issueAttributes": [
    ],
  • "customAttributes": [
    ],
  • "certificateCustomAttributes": [
    ]
}

Response samples

Content type
application/json
{
  • "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
  • "name": "Name",
  • "description": "string",
  • "entityInstanceUuid": "string",
  • "entityInstanceName": "string",
  • "attributes": [
    ],
  • "customAttributes": [
    ],
  • "enabled": true,
  • "supportMultipleEntries": false,
  • "supportKeyManagement": false,
  • "certificates": [
    ],
  • "metadata": [
    ]
}

Enable Location

path Parameters
entityUuid
required
string

Entity UUID

locationUuid
required
string

Location UUID

Responses

Disable Location

path Parameters
entityUuid
required
string

Entity UUID

locationUuid
required
string

Location UUID

Responses

Get Locations searchable fields information

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get push Attributes

path Parameters
entityUuid
required
string

Entity UUID

locationUuid
required
string

Location UUID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get CSR Attributes

path Parameters
entityUuid
required
string

Entity UUID

locationUuid
required
string

Location UUID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Entity Management

Entity Management API

Get Entity instance details

path Parameters
entityUuid
required
string

Entity instance UUID

Responses

Response samples

Content type
application/json
{
  • "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
  • "name": "Name",
  • "attributes": [
    ],
  • "customAttributes": [
    ],
  • "status": "string",
  • "connectorUuid": "string",
  • "connectorName": "string",
  • "kind": "Keystore, etc."
}

Edit Entity instance

path Parameters
entityUuid
required
string

Entity instance UUID

Request Body schema: application/json
required
Array of objects (RequestAttributeDto)

List of Entity instance Attributes

Array of objects (RequestAttributeDto)

List of Custom Attributes

Responses

Request samples

Content type
application/json
{
  • "attributes": [
    ],
  • "customAttributes": [
    ]
}

Response samples

Content type
application/json
{
  • "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
  • "name": "Name",
  • "attributes": [
    ],
  • "customAttributes": [
    ],
  • "status": "string",
  • "connectorUuid": "string",
  • "connectorName": "string",
  • "kind": "Keystore, etc."
}

Delete Entity instance

path Parameters
entityUuid
required
string

Entity instance UUID

Responses

Add Entity instance

Request Body schema: application/json
name
required
string

Entity instance name

required
Array of objects (RequestAttributeDto)

List of Entity instance Attributes

Array of objects (RequestAttributeDto)

List of Custom Attributes

connectorUuid
required
string

UUID of Entity Provider

kind
required
string

Entity instance Kind

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "attributes": [
    ],
  • "customAttributes": [
    ],
  • "connectorUuid": "string",
  • "kind": "Keystore, etc."
}

Response samples

Content type
application/json
{
  • "uuid": "string"
}

Validate Location Attributes

path Parameters
entityUuid
required
string

Entity instance UUID

Request Body schema: application/json
Array
uuid
required
string

UUID of the Attribute

name
required
string

Name of the Attribute

contentType
required
string (AttributeContentType)
Enum: "string" "text" "integer" "boolean" "float" "date" "time" "datetime" "secret" "file" "credential" "codeblock" "object"

Type of the attribute content.

required
Array of BooleanAttributeContent (object) or CodeBlockAttributeContent (object) or CredentialAttributeContent (object) or DateAttributeContent (object) or DateTimeAttributeContent (object) or FileAttributeContent (object) or FloatAttributeContent (object) or IntegerAttributeContent (object) or ObjectAttributeContent (object) or SecretAttributeContent (object) or StringAttributeContent (object) or TextAttributeContent (object) or TimeAttributeContent (object) (BaseAttributeContentDto)

Content of the Attribute

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
*/*
[
  "Error Message 1",
  "Error Message 2"
]

List Entity instances

Request Body schema: application/json
Array of objects (SearchFilterRequestDto)

Certificate filter input

itemsPerPage
integer <int32> <= 1000
Default: 10

Number of entries per page

pageNumber
integer <int32>
Default: 1

Page number for the request

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ],
  • "itemsPerPage": 10,
  • "pageNumber": 1
}

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "itemsPerPage": 0,
  • "pageNumber": 0,
  • "totalPages": 0,
  • "totalItems": 0
}

List Location Attributes

path Parameters
entityUuid
required
string

Entity instance UUID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Entities searchable fields information

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Authority Management

Authority Management API

Details of an Authority instance

path Parameters
uuid
required
string

Authority instance UUID

Responses

Response samples

Content type
application/json
{
  • "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
  • "name": "Name",
  • "attributes": [
    ],
  • "customAttributes": [
    ],
  • "status": "string",
  • "connectorUuid": "string",
  • "connectorName": "string",
  • "kind": "LegacyEjbca, ADCS, etc."
}

Edit Authority instance

path Parameters
uuid
required
string

Authority instance UUID

Request Body schema: application/json
required
Array of objects (RequestAttributeDto)

List of Authority instance Attributes

Array of objects (RequestAttributeDto)

List of Custom Attributes

Responses

Request samples

Content type
application/json
{
  • "attributes": [
    ],
  • "customAttributes": [
    ]
}

Response samples

Content type
application/json
{
  • "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
  • "name": "Name",
  • "attributes": [
    ],
  • "customAttributes": [
    ],
  • "status": "string",
  • "connectorUuid": "string",
  • "connectorName": "string",
  • "kind": "LegacyEjbca, ADCS, etc."
}

Delete Authority instance

path Parameters
uuid
required
string

Authority instance UUID

Responses

Response samples

Content type
application/json
{
  • "message": "Error message"
}

List of available Authority instances

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add Authority instance

Request Body schema: application/json
name
required
string

Authority instance name

required
Array of objects (RequestAttributeDto)

List of Authority instance Attributes

Array of objects (RequestAttributeDto)

List of Custom Attributes

connectorUuid
required
string

UUID of Authority provider

kind
required
string

Authority instance Kind

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "attributes": [
    ],
  • "customAttributes": [
    ],
  • "connectorUuid": "string",
  • "kind": "LegacyEjbca, ADCS, etc"
}

Response samples

Content type
application/json
{
  • "uuid": "string"
}

Delete multiple Authority instances

Request Body schema: application/json

Authority Instance UUIDs

Array
string

Responses

Request samples

Content type
application/json
[
  • "c2f685d4-6a3e-11ec-90d6-0242ac120003",
  • "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

Content type
application/json
[
  • {
    }
]

Validate RA Profile Attributes

path Parameters
uuid
required
string

Authority instance UUID

Request Body schema: application/json
Array
uuid
required
string

UUID of the Attribute

name
required
string

Name of the Attribute

contentType
required
string (AttributeContentType)
Enum: "string" "text" "integer" "boolean" "float" "date" "time" "datetime" "secret" "file" "credential" "codeblock" "object"

Type of the attribute content.

required
Array of BooleanAttributeContent (object) or CodeBlockAttributeContent (object) or CredentialAttributeContent (object) or DateAttributeContent (object) or DateTimeAttributeContent (object) or FileAttributeContent (object) or FloatAttributeContent (object) or IntegerAttributeContent (object) or ObjectAttributeContent (object) or SecretAttributeContent (object) or StringAttributeContent (object) or TextAttributeContent (object) or TimeAttributeContent (object) (BaseAttributeContentDto)

Content of the Attribute

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "message": "Error message"
}

listEntityProfiles

path Parameters
uuid
required
string

Authority instance UUID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

listCertificateProfiles

path Parameters
uuid
required
string

Authority instance UUID

endEntityProfileId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

listCAsInProfile

path Parameters
uuid
required
string

Authority instance UUID

endEntityProfileId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List RA Profile Attributes

path Parameters
uuid
required
string

Authority instance UUID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Force delete multiple Authority instances

Request Body schema: application/json
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
[
  • {
    }
]

RA Profile Management

RA Profile Management API

Details of RA Profile

path Parameters
authorityUuid
required
string

Authority Instance UUID

raProfileUuid
required
string

RA Profile UUID

Responses

Response samples

Content type
application/json
{
  • "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
  • "name": "Name",
  • "description": "string",
  • "authorityInstanceUuid": "string",
  • "authorityInstanceName": "string",
  • "legacyAuthority": true,
  • "enabled": true,
  • "attributes": [
    ],
  • "customAttributes": [
    ],
  • "enabledProtocols": [
    ]
}

Edit RA Profile

path Parameters
authorityUuid
required
string

Authority Instance UUID

raProfileUuid
required
string

RA Profile UUID

Request Body schema: application/json
description
string

Description of RA Profile

required
Array of objects (RequestAttributeDto)

List of Attributes for RA Profile

Array of objects (RequestAttributeDto)

List of Custom Attributes

enabled
boolean

Enabled flag - true = enabled; false = disabled

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "attributes": [
    ],
  • "customAttributes": [
    ],
  • "enabled": true
}

Response samples

Content type
application/json
{
  • "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
  • "name": "Name",
  • "description": "string",
  • "authorityInstanceUuid": "string",
  • "authorityInstanceName": "string",
  • "legacyAuthority": true,
  • "enabled": true,
  • "attributes": [
    ],
  • "customAttributes": [
    ],
  • "enabledProtocols": [
    ]
}

Delete RA Profile

path Parameters
authorityUuid
required
string

Authority Instance UUID

raProfileUuid
required
string

RA Profile UUID

Responses

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Initiate Certificate Compliance Check

Request Body schema: application/json

RA Profile UUIDs

Array
string

Responses

Request samples

Content type
application/json
[
  • "c2f685d4-6a3e-11ec-90d6-0242ac120003",
  • "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Create RA Profile

path Parameters
authorityUuid
required
string

Authority Instance UUID

Request Body schema: application/json
name
required
string

RA Profile name

description
string

RA Profile description

required
Array of objects (RequestAttributeDto)

List of Attributes to create RA Profile

Array of objects (RequestAttributeDto)

List of Custom Attributes

enabled
boolean
Default: false

Enabled flag - true = enabled; false = disabled

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "attributes": [
    ],
  • "customAttributes": [
    ],
  • "enabled": false
}

Response samples

Content type
application/json
{
  • "uuid": "string"
}

Enable multiple RA Profiles

Request Body schema: application/json

RA Profile UUIDs

Array
string

Responses

Request samples

Content type
application/json
[
  • "c2f685d4-6a3e-11ec-90d6-0242ac120003",
  • "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Disable multiple RA Profiles

Request Body schema: application/json

RA Profile UUIDs

Array
string

Responses

Request samples

Content type
application/json
[
  • "c2f685d4-6a3e-11ec-90d6-0242ac120003",
  • "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Deactivate SCEP for RA Profile

path Parameters
authorityUuid
required
string

Authority Instance UUID

raProfileUuid
required
string

RA Profile UUID

Responses

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Activate SCEP for RA Profile

path Parameters
authorityUuid
required
string

Authority Instance UUID

raProfileUuid
required
string

RA Profile UUID

scepProfileUuid
required
string

SCEP Profile UUID

Request Body schema: application/json
required
Array of objects (RequestAttributeDto)

List of Attributes to issue Certificate

Responses

Request samples

Content type
application/json
{
  • "issueCertificateAttributes": [
    ]
}

Response samples

Content type
application/json
{
  • "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
  • "name": "Name",
  • "scepAvailable": true,
  • "url": "string",
  • "issueCertificateAttributes": [
    ]
}

Deactivate ACME for RA Profile

path Parameters
authorityUuid
required
string

Authority Instance UUID

raProfileUuid
required
string

RA Profile UUID

Responses

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Activate ACME for RA Profile

path Parameters
authorityUuid
required
string

Authority Instance UUID

raProfileUuid
required
string

RA Profile UUID

acmeProfileUuid
required
string

ACME Profile UUID

Request Body schema: application/json
required
Array of objects (RequestAttributeDto)

List of Attributes to issue Certificate

required
Array of objects (RequestAttributeDto)

List of Attributes to revoke Certificate

Responses

Request samples

Content type
application/json
{
  • "issueCertificateAttributes": [
    ],
  • "revokeCertificateAttributes": [
    ]
}

Response samples

Content type
application/json
{
  • "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
  • "name": "Name",
  • "acmeAvailable": true,
  • "directoryUrl": "string",
  • "issueCertificateAttributes": [
    ],
  • "revokeCertificateAttributes": [
    ]
}

Enable RA Profiles

path Parameters
authorityUuid
required
string

Authority Instance UUID

raProfileUuid
required
string

RA Profile UUID

Responses

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Disable RA Profiles

path Parameters
authorityUuid
required
string

Authority Instance UUID

raProfileUuid
required
string

RA Profile UUID

Responses

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Disassociated RA profile with the Approval profile

path Parameters
authorityUuid
required
string

Authority instance UUID

raProfileUuid
required
string

RA profile UUID

approvalProfileUuid
required
string

Approval profile UUID

Responses

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Associated RA profile with the Approval profile

path Parameters
authorityUuid
required
string

Authority instance UUID

raProfileUuid
required
string

RA profile UUID

approvalProfileUuid
required
string

Approval profile UUID

Responses

Response samples

Content type
application/json
{
  • "message": "Error message"
}

List of available RA Profiles

query Parameters
enabled
boolean

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete multiple RA Profiles

Request Body schema: application/json

RA Profile UUIDs

Array
string

Responses

Request samples

Content type
application/json
[
  • "c2f685d4-6a3e-11ec-90d6-0242ac120003",
  • "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Details of RA Profile

path Parameters
raProfileUuid
required
string

RA Profile UUID

Responses

Response samples

Content type
application/json
{
  • "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
  • "name": "Name",
  • "description": "string",
  • "authorityInstanceUuid": "string",
  • "authorityInstanceName": "string",
  • "legacyAuthority": true,
  • "enabled": true,
  • "attributes": [
    ],
  • "customAttributes": [
    ],
  • "enabledProtocols": [
    ]
}

Delete RA Profile

path Parameters
raProfileUuid
required
string

RA Profile UUID

Responses

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Get SCEP details for RA Profile

path Parameters
authorityUuid
required
string

Authority Instance UUID

raProfileUuid
required
string

RA Profile UUID

Responses

Response samples

Content type
application/json
{
  • "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
  • "name": "Name",
  • "scepAvailable": true,
  • "url": "string",
  • "issueCertificateAttributes": [
    ]
}

Get ACME details for RA Profile

path Parameters
authorityUuid
required
string

Authority Instance UUID

raProfileUuid
required
string

RA Profile UUID

Responses

Response samples

Content type
application/json
{
  • "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
  • "name": "Name",
  • "acmeAvailable": true,
  • "directoryUrl": "string",
  • "issueCertificateAttributes": [
    ],
  • "revokeCertificateAttributes": [
    ]
}

Get Compliance Profiles for an RA Profile

path Parameters
authorityUuid
required
string

Authority UUID

raProfileUuid
required
string

RA Profile UUID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve certificates of authority belonging to RA profile

path Parameters
authorityUuid
required
string

Authority instance UUID

raProfileUuid
required
string

RA profile UUID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get revocation Attributes

path Parameters
authorityUuid
required
string

Authority Instance UUID

raProfileUuid
required
string

RA Profile UUID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get issue Certificate Attributes

path Parameters
authorityUuid
required
string

Authority Instance UUID

raProfileUuid
required
string

RA Profile UUID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List of Approval profiles associated with the RAProfile

path Parameters
authorityUuid
required
string

Authority instance UUID

raProfileUuid
required
string

RA profile UUID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Discovery Management

Discovery Management API

Create Discovery

Request Body schema: application/json
name
required
string

Discovery name

required
Array of objects (RequestAttributeDto)

List of Attributes for Discovery

Array of objects (RequestAttributeDto)

List of Custom Attributes

connectorUuid
required
string

Discovery Provider UUID

kind
required
string

Discovery Kind

triggers
Array of strings <uuid>

List of triggers to be triggered after the discovery is finished, triggers will be evaluated in given order

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "attributes": [
    ],
  • "customAttributes": [
    ],
  • "connectorUuid": "string",
  • "kind": "string",
  • "triggers": [
    ]
}

Response samples

Content type
application/json
{
  • "uuid": "string"
}

Delete Multiple Discoveries

Request Body schema: application/json

Discovery UUIDs

Array
string

Responses

Request samples

Content type
application/json
[
  • "c2f685d4-6a3e-11ec-90d6-0242ac120003",
  • "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Schedule Discovery

Request Body schema: application/json
jobName
string
cronExpression
string
oneTime
boolean
object (DiscoveryDto)

Responses

Request samples

Content type
application/json
{
  • "jobName": "string",
  • "cronExpression": "string",
  • "oneTime": true,
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "string"
}

List Discovery

Request Body schema: application/json
Array of objects (SearchFilterRequestDto)

Certificate filter input

itemsPerPage
integer <int32> <= 1000
Default: 10

Number of entries per page

pageNumber
integer <int32>
Default: 1

Page number for the request

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ],
  • "itemsPerPage": 10,
  • "pageNumber": 1
}

Response samples

Content type
application/json
{
  • "discoveries": [
    ],
  • "itemsPerPage": 0,
  • "pageNumber": 0,
  • "totalPages": 0,
  • "totalItems": 0
}

Discovery Details

path Parameters
uuid
required
string

Discovery UUID

Responses

Response samples

Content type
application/json
{
  • "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
  • "name": "Name",
  • "kind": "IP-HostName",
  • "status": "inProgress",
  • "message": "Failed due to network connectivity issues",
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "totalCertificatesDiscovered": 0,
  • "connectorUuid": "string",
  • "connectorName": "string",
  • "attributes": [
    ],
  • "customAttributes": [
    ],
  • "metadata": [
    ],
  • "triggers": [
    ]
}

Delete Discovery

path Parameters
uuid
required
string

Discovery UUID

Responses

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Discovery Details

path Parameters
uuid
required
string

Discovery UUID

query Parameters
newlyDiscovered
boolean
itemsPerPage
integer <int32>
Default: 10
pageNumber
integer <int32>
Default: 0

Responses

Response samples

Content type
application/json
{
  • "certificates": [
    ],
  • "itemsPerPage": 0,
  • "pageNumber": 0,
  • "totalPages": 0,
  • "totalItems": 0
}

Get Discovery searchable fields information

Responses

Response samples

Content type
application/json
[
  • {
    }
]

ACME Profile Management

ACME Profile Management API

Get details of ACME Profile

path Parameters
uuid
required
string

ACME Profile UUID

Responses

Response samples

Content type
application/json
{
  • "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
  • "name": "Name",
  • "enabled": true,
  • "description": "Sample description",
  • "termsOfServiceUrl": "https://sample-url.com/termsOfService",
  • "websiteUrl": "https://sample-company.com",
  • "dnsResolverIp": "8.8.8.8",
  • "dnsResolverPort": "53",
  • "raProfile": {
    },
  • "retryInterval": 30,
  • "termsOfServiceChangeDisable": false,
  • "validity": 36000,
  • "directoryUrl": "https://some-server.com/api/v1/protocols/acme/profile1/directory",
  • "termsOfServiceChangeUrl": "https://some-company.com/termsOfService/change",
  • "requireContact": true,
  • "requireTermsOfService": true,
  • "issueCertificateAttributes": [
    ],
  • "revokeCertificateAttributes": [
    ],
  • "customAttributes": [
    ]
}

Edit ACME Profile

path Parameters
uuid
required
string

ACME Profile UUID

Request Body schema: application/json
description
string

Description of the ACME Profile

termsOfServiceUrl
string

Terms of Service URL

websiteUrl
string

Website URL

dnsResolverIp
string
Default: "System Default"

DNS Resolver IP address

dnsResolverPort
string
Default: "53"

DNS Resolver port number

raProfileUuid
string

RA Profile UUID

retryInterval
integer <int32>
Default: 30

Retry interval for the Orders

termsOfServiceChangeDisable
boolean
Default: false

Disable new Orders due to change in Terms of Service

termsOfServiceChangeUrl
string

Changes of Terms of Service URL

validity
integer <int32>
Default: 36000

Order Validity

required
Array of objects (RequestAttributeDto)

List of Attributes to issue Certificate

required
Array of objects (RequestAttributeDto)

List of Attributes to revoke Certificate

requireContact
boolean
Default: false

Require contact information for new Account

requireTermsOfService
boolean
Default: false

Require new Account to agree on Terms of Service

Array of objects (RequestAttributeDto)

List of Custom Attributes

Responses

Request samples

Content type
application/json
{
  • "description": "Sample description",
  • "termsOfServiceUrl": "https://sample-url.com/termsOfService",
  • "websiteUrl": "https://sample-url.com",
  • "dnsResolverIp": "8.8.8.8",
  • "dnsResolverPort": "53",
  • "raProfileUuid": "6b55de1c-844f-11ec-a8a3-0242ac120002",
  • "retryInterval": 60,
  • "termsOfServiceChangeDisable": false,
  • "termsOfServiceChangeUrl": "https://sample-url.com/termsOfService/change",
  • "validity": 3000,
  • "issueCertificateAttributes": [
    ],
  • "revokeCertificateAttributes": [
    ],
  • "requireContact": true,
  • "requireTermsOfService": false,
  • "customAttributes": [
    ]
}

Response samples

Content type
application/json
{
  • "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
  • "name": "Name",
  • "enabled": true,
  • "description": "Sample description",
  • "termsOfServiceUrl": "https://sample-url.com/termsOfService",
  • "websiteUrl": "https://sample-company.com",
  • "dnsResolverIp": "8.8.8.8",
  • "dnsResolverPort": "53",
  • "raProfile": {
    },
  • "retryInterval": 30,
  • "termsOfServiceChangeDisable": false,
  • "validity": 36000,
  • "directoryUrl": "https://some-server.com/api/v1/protocols/acme/profile1/directory",
  • "termsOfServiceChangeUrl": "https://some-company.com/termsOfService/change",
  • "requireContact": true,
  • "requireTermsOfService": true,
  • "issueCertificateAttributes": [
    ],
  • "revokeCertificateAttributes": [
    ],
  • "customAttributes": [
    ]
}

Delete ACME Profile

path Parameters
uuid
required
string

ACME Profile UUID

Responses

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Get list of ACME Profiles

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create ACME Profile

Request Body schema: application/json
name
required
string

Name of the ACME Profile

description
string

Description of the ACME Profile

termsOfServiceUrl
string

Terms of Service URL

websiteUrl
string

Website URL

dnsResolverIp
string
Default: "System Default"

DNS Resolver IP address

dnsResolverPort
string
Default: "53"

DNS Resolver port number

raProfileUuid
string

RA Profile UUID

retryInterval
integer <int32>
Default: 30

Retry interval for the Orders

validity
integer <int32>
Default: 36000

Order Validity

required
Array of objects (RequestAttributeDto)

List of Attributes to issue Certificate

required
Array of objects (RequestAttributeDto)

List of Attributes to revoke Certificate

requireContact
boolean
Default: false

Require contact information for new Account

requireTermsOfService
boolean
Default: false

Require new Account to agree on Terms of Service

Array of objects (RequestAttributeDto)

List of Custom Attributes

Responses

Request samples

Content type
application/json
{
  • "name": "Profile Name 1",
  • "description": "Sample description",
  • "termsOfServiceUrl": "https://sample-url.com/termsOfService",
  • "websiteUrl": "https://sample-url.com",
  • "dnsResolverIp": "8.8.8.8",
  • "dnsResolverPort": "53",
  • "raProfileUuid": "6b55de1c-844f-11ec-a8a3-0242ac120002",
  • "retryInterval": 60,
  • "validity": 3000,
  • "issueCertificateAttributes": [
    ],
  • "revokeCertificateAttributes": [
    ],
  • "requireContact": true,
  • "requireTermsOfService": false,
  • "customAttributes": [
    ]
}

Response samples

Content type
application/json
{
  • "uuid": "string"
}

Update RA Profile for ACME Profile

path Parameters
uuid
required
string

ACME Profile UUID

raProfileUuid
required
string

RA Profile UUID

Responses

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Enable ACME Profile

path Parameters
uuid
required
string

ACME Profile UUID

Responses

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Disable ACME Profile

path Parameters
uuid
required
string

ACME Profile UUID

Responses

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Enable multiple ACME Profiles

Request Body schema: application/json

ACME Profile UUIDs

Array
string

Responses

Request samples

Content type
application/json
[
  • "c2f685d4-6a3e-11ec-90d6-0242ac120003",
  • "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Disable multiple ACME Profile

Request Body schema: application/json

ACME Profile UUIDs

Array
string

Responses

Request samples

Content type
application/json
[
  • "c2f685d4-6a3e-11ec-90d6-0242ac120003",
  • "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Delete multiple ACME Profiles

Request Body schema: application/json

ACME Profile UUIDs

Array
string

Responses

Request samples

Content type
application/json
[
  • "c2f685d4-6a3e-11ec-90d6-0242ac120003",
  • "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

Content type
application/json
[
  • {
    }
]

Force delete multiple ACME Profiles

Request Body schema: application/json

ACME Profile UUIDs

Array
string

Responses

Request samples

Content type
application/json
[
  • "c2f685d4-6a3e-11ec-90d6-0242ac120003",
  • "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

Content type
application/json
[
  • {
    }
]

Approval profile Inventory

Approval profile Inventory API

Get Approval Profile Details

path Parameters
uuid
required
string

Approval profile UUID

query Parameters
required
object (ApprovalProfileForVersionDto)

Select specific version of the approval profile

Responses

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "ApprovalProfile1",
  • "version": 1,
  • "description": "Detail description of the approval profile",
  • "enabled": true,
  • "expiry": 30,
  • "numberOfSteps": 2,
  • "associations": 0,
  • "approvalSteps": [
    ]
}

Edit an Approval profile

path Parameters
uuid
required
string

Approval profile UUID

Request Body schema: application/json
description
string

Description of the Approval profile

expiry
integer <int32>

Expiration of the Approval profile in hours

required
Array of objects (ApprovalStepRequestDto)

List of Approval steps for the Approval profile

Responses

Request samples

Content type
application/json
{
  • "description": "Detail description of the approval profile",
  • "expiry": 30,
  • "approvalSteps": [
    ]
}

Response samples

Content type
application/json
{ }

Delete an approval profile

path Parameters
uuid
required
string

Approval profile UUID

Responses

Response samples

Content type
application/json
{
  • "message": "Error message"
}

List Approval Profiles

query Parameters
required
object (PaginationRequestDto)

Responses

Response samples

Content type
application/json
{
  • "itemsPerPage": 0,
  • "pageNumber": 0,
  • "totalPages": 0,
  • "totalItems": 0,
  • "approvalProfiles": [
    ]
}

Create a Approval profile

Request Body schema: application/json
name
required
string

Name of the Approval profile

description
string

Description of the Approval profile

enabled
required
boolean

Enable of the Approval profile

expiry
integer <int32>

Expiration of the Approval profile in hours

required
Array of objects (ApprovalStepRequestDto)

List of Approval steps for the Approval profile

Responses

Request samples

Content type
application/json
{
  • "name": "ApprovalProfile1",
  • "description": "Detail description of the approval profile",
  • "enabled": true,
  • "expiry": 30,
  • "approvalSteps": [
    ]
}

Response samples

Content type
application/json
{
  • "uuid": "string"
}

Enabling of Approval profile

path Parameters
uuid
required
string

Approval profile UUID

Responses

Disabling of Approval profile

path Parameters
uuid
required
string

Approval profile UUID

Responses

Custom Attributes

Custom Attributes API

Custom Attribute details

path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "contentType": "string",
  • "description": "string",
  • "enabled": true,
  • "type": "data",
  • "label": "Attribute Name",
  • "required": true,
  • "visible": true,
  • "group": "requiredAttributes",
  • "readOnly": false,
  • "list": false,
  • "multiSelect": false,
  • "content": [
    ],
  • "resources": [
    ]
}

Edit Custom Attribute

path Parameters
uuid
required
string

Attribute UUID

Request Body schema: application/json
description
string

Attribute description

label
required
string

Friendly name of the the Attribute

visible
boolean
Default: true

Boolean determining if the Attribute is visible and can be displayed, otherwise it should be hidden to the user.

group
string

Group of the Attribute, used for the logical grouping of the Attribute

required
boolean
Default: false

Boolean determining if the Attribute is required. If true, the Attribute must be provided.

readOnly
boolean
Default: false

Boolean determining if the Attribute is read only. If true, the Attribute content cannot be changed.

list
boolean
Default: false

Boolean determining if the Attribute contains list of values in the content

multiSelect
boolean
Default: false

Boolean determining if the Attribute can have multiple values

Array of BooleanAttributeContent (object) or CodeBlockAttributeContent (object) or CredentialAttributeContent (object) or DateAttributeContent (object) or DateTimeAttributeContent (object) or FileAttributeContent (object) or FloatAttributeContent (object) or IntegerAttributeContent (object) or ObjectAttributeContent (object) or SecretAttributeContent (object) or StringAttributeContent (object) or TextAttributeContent (object) or TimeAttributeContent (object) (BaseAttributeContentDto)

Predefined content for the attribute if needed. The content of the Attribute must satisfy the type

resources
Array of strings (Resource)
Items Enum: "NONE" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "notificationInstances" "users" "roles" "acmeAccounts" "acmeProfiles" "scepProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals"

List of resource to be associated with the custom attribute

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "label": "Attribute Name",
  • "visible": true,
  • "group": "requiredAttributes",
  • "required": false,
  • "readOnly": false,
  • "list": false,
  • "multiSelect": false,
  • "content": [
    ],
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "contentType": "string",
  • "description": "string",
  • "enabled": true,
  • "type": "data",
  • "label": "Attribute Name",
  • "required": true,
  • "visible": true,
  • "group": "requiredAttributes",
  • "readOnly": false,
  • "list": false,
  • "multiSelect": false,
  • "content": [
    ],
  • "resources": [
    ]
}

Delete Custom Attribute

path Parameters
uuid
required
string

Custom Attribute UUID

Responses

Response samples

Content type
application/json
{
  • "message": "Error message"
}

List Custom Attributes

query Parameters
attributeContentType
string (AttributeContentType)
Enum: "string" "text" "integer" "boolean" "float" "date" "time" "datetime" "secret" "file" "credential" "codeblock" "object"

Type of the attribute content.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Custom Attribute

Request Body schema: application/json
name
required
string

Name of the Attribute

contentType
required
string (AttributeContentType)
Enum: "string" "text" "integer" "boolean" "float" "date" "time" "datetime" "secret" "file" "credential" "codeblock" "object"

Type of the attribute content.

description
string

Attribute description

label
required
string

Friendly name of the the Attribute

visible
boolean
Default: true

Boolean determining if the Attribute is visible and can be displayed, otherwise it should be hidden to the user.

group
string

Group of the Attribute, used for the logical grouping of the Attribute

required
boolean
Default: false

Boolean determining if the Attribute is required. If true, the Attribute must be provided.

readOnly
boolean
Default: false

Boolean determining if the Attribute is read only. If true, the Attribute content cannot be changed.

list
boolean
Default: false

Boolean determining if the Attribute contains list of values in the content

multiSelect
boolean
Default: false

Boolean determining if the Attribute can have multiple values

Array of BooleanAttributeContent (object) or CodeBlockAttributeContent (object) or CredentialAttributeContent (object) or DateAttributeContent (object) or DateTimeAttributeContent (object) or FileAttributeContent (object) or FloatAttributeContent (object) or IntegerAttributeContent (object) or ObjectAttributeContent (object) or SecretAttributeContent (object) or StringAttributeContent (object) or TextAttributeContent (object) or TimeAttributeContent (object) (BaseAttributeContentDto)

Predefined content for the attribute if needed. The content of the Attribute must satisfy the type

resources
Array of strings (Resource)
Items Enum: "NONE" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "notificationInstances" "users" "roles" "acmeAccounts" "acmeProfiles" "scepProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals"

List of resource to be associated with the custom attribute

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "contentType": "string",
  • "description": "string",
  • "label": "Attribute Name",
  • "visible": true,
  • "group": "requiredAttributes",
  • "required": false,
  • "readOnly": false,
  • "list": false,
  • "multiSelect": false,
  • "content": [
    ],
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "uuid": "string"
}

Delete multiple Custom Attributes

Request Body schema: application/json

Attribute UUIDs

Array
string

Responses

Request samples

Content type
application/json
[
  • "c2f685d4-6a3e-11ec-90d6-0242ac120003",
  • "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Associate Custom Attribute to Resource

path Parameters
uuid
required
string

Custom Attribute UUID

Request Body schema: application/json

List of Resources

Array
string

Responses

Request samples

Content type
application/json
[
  • "raProfiles",
  • "authorities"
]

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Enable Custom Attribute

path Parameters
uuid
required
string

Custom Attribute UUID

Responses

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Disable Custom Attribute

path Parameters
uuid
required
string

Custom Attribute UUID

Responses

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Delete Value of a Custom Attribute for a Resource

path Parameters
resourceName
required
string (Resource)
Enum: "NONE" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "notificationInstances" "users" "roles" "acmeAccounts" "acmeProfiles" "scepProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals"

Resource Type

objectUuid
required
string

Object UUID

attributeUuid
required
string

Custom Attribute UUID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update Value of a Custom Attribute for a Resource

path Parameters
resourceName
required
string (Resource)
Enum: "NONE" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "notificationInstances" "users" "roles" "acmeAccounts" "acmeProfiles" "scepProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals"

Resource Type

objectUuid
required
string

Object UUID

attributeUuid
required
string

Custom Attribute UUID

Request Body schema: application/json
Array
One of
reference
string

Content Reference

data
required
object

Boolean attribute value

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Enable multiple Custom Attributes

Request Body schema: application/json

Attribute UUIDs

Array
string

Responses

Request samples

Content type
application/json
[
  • "c2f685d4-6a3e-11ec-90d6-0242ac120003",
  • "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Disable multiple Custom Attributes

Request Body schema: application/json

Attribute UUIDs

Array
string

Responses

Request samples

Content type
application/json
[
  • "c2f685d4-6a3e-11ec-90d6-0242ac120003",
  • "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Get available resources for Custom Attributes

Responses

Response samples

Content type
application/json
[
  • "NONE"
]

Get Custom Attributes for a resource

path Parameters
resource
required
string (Resource)
Enum: "NONE" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "notificationInstances" "users" "roles" "acmeAccounts" "acmeProfiles" "scepProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals"

Resource Name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Rules Management

Rules Management API

Get Rule details

path Parameters
ruleUuid
required
string

Rule UUID

Responses

Response samples

Content type
application/json
{
  • "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
  • "name": "Name",
  • "connector_uuid": "string",
  • "description": "string",
  • "resource": "NONE",
  • "resourceType": "string",
  • "resourceFormat": "string",
  • "attributes": [
    ],
  • "conditions": [
    ],
  • "conditionGroups": [
    ]
}

Update Rule

path Parameters
ruleUuid
required
string

Rule UUID

Request Body schema: application/json
description
string

Description of the Rule

resourceType
string

Type of the Resource associated with the Rule

resourceFormat
string

Format of the Resource associated with the Rule

Array of objects (RuleConditionRequestDto)

List of conditions to add in the Rule

conditionGroupsUuids
Array of strings

List of UUIDs of existing condition groups to add in the Rule

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "resourceType": "string",
  • "resourceFormat": "string",
  • "conditions": [
    ],
  • "conditionGroupsUuids": [
    ]
}

Response samples

Content type
application/json
{
  • "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
  • "name": "Name",
  • "connector_uuid": "string",
  • "description": "string",
  • "resource": "NONE",
  • "resourceType": "string",
  • "resourceFormat": "string",
  • "attributes": [
    ],
  • "conditions": [
    ],
  • "conditionGroups": [
    ]
}

Delete Rule

path Parameters
ruleUuid
required
string

Rule UUID

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "code": "string",
  • "message": "string"
}

Get Trigger details

path Parameters
triggerUuid
required
string

Trigger UUID

Responses

Response samples

Content type
application/json
{
  • "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
  • "name": "Name",
  • "description": "string",
  • "triggerType": "event",
  • "eventName": "discoveryFinished",
  • "resource": "NONE",
  • "triggerResource": "NONE",
  • "rules": [
    ],
  • "actionGroups": [
    ],
  • "actions": [
    ]
}

Update Trigger

path Parameters
triggerUuid
required
string

Trigger UUID

Request Body schema: application/json
description
string

Description of the Rule Trigger

triggerType
required
string (RuleTriggerType)
Enum: "event" "manual"

Type of the Rule Trigger

eventName
string
Value: "discoveryFinished"

Event of the Rule Trigger

triggerResource
string (Resource)
Enum: "NONE" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "notificationInstances" "users" "roles" "acmeAccounts" "acmeProfiles" "scepProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals"

Source Object Type

resource
string (Resource)
Enum: "NONE" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "notificationInstances" "users" "roles" "acmeAccounts" "acmeProfiles" "scepProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals"

Source Object Type

rulesUuids
Array of strings

List of UUIDs of existing Rules to add in the Rule Trigger

actionGroupsUuids
Array of strings

List of UUIDs of existing Action Groups to add in the Rule Trigger

Array of objects (RuleActionRequestDto)

List of new Rule Actions to add in the Rule Trigger

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "triggerType": "event",
  • "eventName": "discoveryFinished",
  • "triggerResource": "NONE",
  • "resource": "NONE",
  • "rulesUuids": [
    ],
  • "actionGroupsUuids": [
    ],
  • "actions": [
    ]
}

Response samples

Content type
application/json
{
  • "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
  • "name": "Name",
  • "description": "string",
  • "triggerType": "event",
  • "eventName": "discoveryFinished",
  • "resource": "NONE",
  • "triggerResource": "NONE",
  • "rules": [
    ],
  • "actionGroups": [
    ],
  • "actions": [
    ]
}

Delete Trigger

path Parameters
triggerUuid
required
string

Trigger UUID

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "code": "string",
  • "message": "string"
}

Get Condition Group details

path Parameters
conditionGroupUuid
required
string

Condition Group UUID

Responses

Response samples

Content type
application/json
{
  • "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
  • "name": "Name",
  • "description": "string",
  • "resource": "NONE",
  • "conditions": [
    ]
}

Update Condition Group

path Parameters
conditionGroupUuid
required
string

Condition Group UUID

Request Body schema: application/json
description
string

Description of the Rule Condition Group

required
Array of objects (RuleConditionRequestDto)

List of the Rule Conditions to add in the Rule Condition Group

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "conditions": [
    ]
}

Response samples

Content type
application/json
{
  • "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
  • "name": "Name",
  • "description": "string",
  • "resource": "NONE",
  • "conditions": [
    ]
}

Delete Condition Group

path Parameters
conditionGroupUuid
required
string

Condition Group UUID

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "code": "string",
  • "message": "string"
}

Get Action Group Details

path Parameters
actionGroupUuid
required
string

Action Group UUID

Responses

Response samples

Content type
application/json
{
  • "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
  • "name": "Name",
  • "description": "string",
  • "resource": "NONE",
  • "actions": [
    ]
}

Update Action Group

path Parameters
actionGroupUuid
required
string

Action Group UUID

Request Body schema: application/json
description
string

Description of the Rule Action Group

required
Array of objects (RuleActionRequestDto)

List of new Rule Actions to add in the Rule Actions Group

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "actions": [
    ]
}

Response samples

Content type
application/json
{
  • "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
  • "name": "Name",
  • "description": "string",
  • "resource": "NONE",
  • "actions": [
    ]
}

Delete Action Group

path Parameters
actionGroupUuid
required
string

Action Group UUID

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "code": "string",
  • "message": "string"
}

List Rules

query Parameters
resource
string (Resource)
Enum: "NONE" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "notificationInstances" "users" "roles" "acmeAccounts" "acmeProfiles" "scepProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals"

Source Object Type

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Rule

Request Body schema: application/json
name
required
string

Name of the Rule

description
string

Description of the Rule

resource
required
string (Resource)
Enum: "NONE" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "notificationInstances" "users" "roles" "acmeAccounts" "acmeProfiles" "scepProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals"

Source Object Type

resourceType
string

Type of the Resource associated with the Rule

resourceFormat
string

Format of the Resource associated with the Rule

Array of objects (RuleConditionRequestDto)

List of conditions to add in the Rule

conditionGroupsUuids
Array of strings

List of UUIDs of existing condition groups to add in the Rule

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "resource": "NONE",
  • "resourceType": "string",
  • "resourceFormat": "string",
  • "conditions": [
    ],
  • "conditionGroupsUuids": [
    ]
}

Response samples

Content type
application/json
{
  • "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
  • "name": "Name",
  • "connector_uuid": "string",
  • "description": "string",
  • "resource": "NONE",
  • "resourceType": "string",
  • "resourceFormat": "string",
  • "attributes": [
    ],
  • "conditions": [
    ],
  • "conditionGroups": [
    ]
}

List Triggers

query Parameters
resource
string (Resource)
Enum: "NONE" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "notificationInstances" "users" "roles" "acmeAccounts" "acmeProfiles" "scepProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals"

Source Object Type

triggerResource
string (Resource)
Enum: "NONE" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "notificationInstances" "users" "roles" "acmeAccounts" "acmeProfiles" "scepProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals"

Source Object Type

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Trigger

Request Body schema: application/json
name
required
string

Name of the Rule Trigger

description
string

Description of the Rule Trigger

triggerType
required
string (RuleTriggerType)
Enum: "event" "manual"

Type of the Rule Trigger

eventName
string
Value: "discoveryFinished"

Name of the event of the Rule Trigger

resource
required
string (Resource)
Enum: "NONE" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "notificationInstances" "users" "roles" "acmeAccounts" "acmeProfiles" "scepProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals"

Source Object Type

triggerResource
string (Resource)
Enum: "NONE" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "notificationInstances" "users" "roles" "acmeAccounts" "acmeProfiles" "scepProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals"

Source Object Type

rulesUuids
Array of strings

List of UUIDs of existing Rules to add in the Rule Trigger

actionGroupsUuids
Array of strings

List of UUIDs of existing Action Groups to add in the Rule Trigger

Array of objects (RuleActionRequestDto)

List of new Rule Actions to add in the Rule Trigger

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "triggerType": "event",
  • "eventName": "discoveryFinished",
  • "resource": "NONE",
  • "triggerResource": "NONE",
  • "rulesUuids": [
    ],
  • "actionGroupsUuids": [
    ],
  • "actions": [
    ]
}

Response samples

Content type
application/json
{
  • "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
  • "name": "Name",
  • "description": "string",
  • "triggerType": "event",
  • "eventName": "discoveryFinished",
  • "resource": "NONE",
  • "triggerResource": "NONE",
  • "rules": [
    ],
  • "actionGroups": [
    ],
  • "actions": [
    ]
}

List Condition Groups

query Parameters
resource
string (Resource)
Enum: "NONE" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "notificationInstances" "users" "roles" "acmeAccounts" "acmeProfiles" "scepProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals"

Source Object Type

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Condition Group

Request Body schema: application/json
name
required
string

Name of the Rule Condition Group

description
string

Description of the Rule Condition Group

resource
required
string (Resource)
Enum: "NONE" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "notificationInstances" "users" "roles" "acmeAccounts" "acmeProfiles" "scepProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals"

Source Object Type

required
Array of objects (RuleConditionRequestDto)

List of the Rule Conditions to add in the Rule Condition Group

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "resource": "NONE",
  • "conditions": [
    ]
}

Response samples

Content type
application/json
{
  • "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
  • "name": "Name",
  • "description": "string",
  • "resource": "NONE",
  • "conditions": [
    ]
}

List Action Groups

query Parameters
resource
string (Resource)
Enum: "NONE" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "notificationInstances" "users" "roles" "acmeAccounts" "acmeProfiles" "scepProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals"

Source Object Type

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Action Group

Request Body schema: application/json
name
required
string

Name of the Rule Action Group

description
string

Description of the Rule Action Group

resource
required
string (Resource)
Enum: "NONE" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "notificationInstances" "users" "roles" "acmeAccounts" "acmeProfiles" "scepProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals"

Source Object Type

required
Array of objects (RuleActionRequestDto)

List of new Rule Actions to add in the Rule Actions Group

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "resource": "NONE",
  • "actions": [
    ]
}

Response samples

Content type
application/json
{
  • "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
  • "name": "Name",
  • "description": "string",
  • "resource": "NONE",
  • "actions": [
    ]
}

Internal Notification

Internal Notifications API that manages notifications for logged user in the platform. Note that this API does not manage nor trigger external notifications. For external notifications, please refer to the External Notification Management API.

List notifications for logged user

query Parameters
required
object (NotificationRequestDto)

Show only unread notifications

Responses

Response samples

Content type
application/json
{
  • "itemsPerPage": 0,
  • "pageNumber": 0,
  • "totalPages": 0,
  • "totalItems": 0,
  • "items": [
    ]
}

Delete a list of notifications for logged user

Request Body schema: application/json

Notifications UUIDs

Array
string

Responses

Request samples

Content type
application/json
[
  • "c2f685d4-6a3e-11ec-90d6-0242ac120003",
  • "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Mark a list of notifications as read for logged user

Request Body schema: application/json

Notifications UUIDs

Array
string

Responses

Request samples

Content type
application/json
[
  • "c2f685d4-6a3e-11ec-90d6-0242ac120003",
  • "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Delete a notification for logged user

path Parameters
uuid
required
string

Notification UUID

Responses

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Mark notification as read for logged user

path Parameters
uuid
required
string

Notification UUID

Responses

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Token Profile Management

Token Profile Management API

Details of Token Profile

path Parameters
tokenInstanceUuid
required
string

Token Instance UUID

uuid
required
string

Token Profile UUID

Responses

Response samples

Content type
application/json
{
  • "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
  • "name": "Name",
  • "description": "string",
  • "tokenInstanceUuid": "string",
  • "tokenInstanceName": "string",
  • "attributes": [
    ],
  • "customAttributes": [
    ],
  • "tokenInstanceStatus": "Connected",
  • "enabled": true,
  • "usages": [
    ]
}

Edit Token Profile

path Parameters
tokenInstanceUuid
required
string

Token Instance UUID

uuid
required
string

Token Profile UUID

Request Body schema: application/json
description
string

Description of Token Profile

required
Array of objects (RequestAttributeDto)

List of Attributes for Token Profile

Array of objects (RequestAttributeDto)

List of Custom Attributes

enabled
boolean

Enabled flag - true = enabled; false = disabled

usage
Array of strings (KeyUsage)
Items Enum: "sign" "verify" "encrypt" "decrypt" "wrap" "unwrap"

Usages for the Key

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "attributes": [
    ],
  • "customAttributes": [
    ],
  • "enabled": true,
  • "usage": [
    ]
}

Response samples

Content type
application/json
{
  • "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
  • "name": "Name",
  • "description": "string",
  • "tokenInstanceUuid": "string",
  • "tokenInstanceName": "string",
  • "attributes": [
    ],
  • "customAttributes": [
    ],
  • "tokenInstanceStatus": "Connected",
  • "enabled": true,
  • "usages": [
    ]
}

Delete Token Profile

path Parameters
tokenInstanceUuid
required
string

Token Instance UUID

uuid
required
string

Token Profile UUID

Responses

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Update Key Usage

path Parameters
tokenInstanceUuid
required
string

Token Instance UUID

tokenProfileUuid
required
string

Token Profile UUID

Request Body schema: application/json
usage
required
Array of strings (KeyUsage)
Items Enum: "sign" "verify" "encrypt" "decrypt" "wrap" "unwrap"

Usages for the Key

Responses

Request samples

Content type
application/json
{
  • "usage": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Update Key Usages for Multiple Token Profiles

Request Body schema: application/json
usage
required
Array of strings (KeyUsage)
Items Enum: "sign" "verify" "encrypt" "decrypt" "wrap" "unwrap"

Usages for the Key

uuids
required
Array of strings <uuid>

Token Profile UUIDs

Responses

Request samples

Content type
application/json
{
  • "usage": [
    ],
  • "uuids": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Create Token Profile

path Parameters
tokenInstanceUuid
required
string

Token Instance UUID

Request Body schema: application/json
name
required
string

Token Profile name

description
string

Token Profile description

required
Array of objects (RequestAttributeDto)

List of Attributes to create Token Profile

Array of objects (RequestAttributeDto)

List of Custom Attributes

enabled
boolean
Default: false

Enabled flag - true = enabled; false = disabled

usage
Array of strings (KeyUsage)
Items Enum: "sign" "verify" "encrypt" "decrypt" "wrap" "unwrap"

Usages for the Key

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "attributes": [
    ],
  • "customAttributes": [
    ],
  • "enabled": false,
  • "usage": [
    ]
}

Response samples

Content type
application/json
{
  • "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
  • "name": "Name",
  • "description": "string",
  • "tokenInstanceUuid": "string",
  • "tokenInstanceName": "string",
  • "attributes": [
    ],
  • "customAttributes": [
    ],
  • "tokenInstanceStatus": "Connected",
  • "enabled": true,
  • "usages": [
    ]
}

Enable Token Profile

path Parameters
tokenInstanceUuid
required
string

Token Instance UUID

uuid
required
string

Token Profile UUID

Responses

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Disable Token Profile

path Parameters
tokenInstanceUuid
required
string

Token Instance UUID

uuid
required
string

Token Profile UUID

Responses

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Enable multiple Token Profiles

Request Body schema: application/json

Token Profile UUIDs

Array
string

Responses

Request samples

Content type
application/json
[
  • "c2f685d4-6a3e-11ec-90d6-0242ac120003",
  • "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Disable multiple Token Profiles

Request Body schema: application/json

Token Profile UUIDs

Array
string

Responses

Request samples

Content type
application/json
[
  • "c2f685d4-6a3e-11ec-90d6-0242ac120003",
  • "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

Content type
application/json
{
  • "message": "Error message"
}

List of available Token Profiles

query Parameters
enabled
boolean

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete multiple Token Profiles

Request Body schema: application/json

Token Profile UUIDs

Array
string

Responses

Request samples

Content type
application/json
[
  • "c2f685d4-6a3e-11ec-90d6-0242ac120003",
  • "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Delete Token Profile

path Parameters
uuid
required
string

Token Profile UUID

Responses

Response samples

Content type
application/json
{
  • "message": "Error message"
}

ACME Account Management

ACME Account Management API

Revoke multiple ACME Accounts

Request Body schema: application/json

ACME Account UUIDs

Array
string

Responses

Request samples

Content type
application/json
[
  • "c2f685d4-6a3e-11ec-90d6-0242ac120003",
  • "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Details of ACME Account

path Parameters
acmeProfileUuid
required
string

ACME Profile UUID

acmeAccountUuid
required
string

ACME Account UUID

Responses

Response samples

Content type
application/json
{
  • "accountId": "TtrgfYTR6F",
  • "uuid": "6b55de1c-844f-11ec-a8a3-0242ac120002",
  • "enabled": false,
  • "totalOrders": 23,
  • "successfulOrders": 2,
  • "failedOrders": 239,
  • "pendingOrders": 24,
  • "validOrders": 23,
  • "processingOrders": 27,
  • "status": "VALID",
  • "contact": "mailto: someadmin@domain.com",
  • "termsOfServiceAgreed": true,
  • "raProfile": {
    },
  • "acmeProfileName": "ACME Profile 1",
  • "acmeProfileUuid": "6b55de1c-844f-11ec-a8a3-0242ac120002"
}

Revoke ACME Account

path Parameters
acmeProfileUuid
required
string

ACME Profile UUID

acmeAccountUuid
required
string

ACME Account UUID

Responses

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Enable ACME Account

path Parameters
acmeProfileUuid
required
string

ACME Profile UUID

acmeAccountUuid
required
string

ACME Account UUID

Responses

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Disable ACME Account

path Parameters
acmeProfileUuid
required
string

ACME Profile UUID

acmeAccountUuid
required
string

ACME Account UUID

Responses

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Enable multiple ACME Accounts

Request Body schema: application/json

ACME Account UUIDs

Array
string

Responses

Request samples

Content type
application/json
[
  • "c2f685d4-6a3e-11ec-90d6-0242ac120003",
  • "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Disable multiple ACME Accounts

Request Body schema: application/json

ACME Account UUIDs

Array
string

Responses

Request samples

Content type
application/json
[
  • "c2f685d4-6a3e-11ec-90d6-0242ac120003",
  • "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

Content type
application/json
{
  • "message": "Error message"
}

List ACME Accounts

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Audit Log

Audit Log API

List Audit logs

query Parameters
required
object (AuditLogFilter)
required
object (Pageable)

Responses

Response samples

Content type
application/json
{
  • "itemsPerPage": 0,
  • "pageNumber": 0,
  • "totalPages": 0,
  • "totalItems": 0,
  • "items": [
    ]
}

List Status

Responses

Response samples

Content type
application/json
[
  • "string"
]

Purge Audit logs

query Parameters
required
object (AuditLogFilter)
required
object (Pageable)

Responses

Response samples

Content type
application/json
{
  • "message": "Error message"
}

List Audit Operations

Responses

Response samples

Content type
application/json
[
  • "string"
]

List Audit Objects

Responses

Response samples

Content type
application/json
[
  • "string"
]

Export Audit logs

query Parameters
required
object (AuditLogFilter)
required
object (Pageable)

Responses

Response samples

Content type
application/json
"string"

Certificate & Key Group

Group API

Group details

path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
  • "name": "Name",
  • "description": "string",
  • "email": "string",
  • "customAttributes": [
    ]
}

Edit Group

path Parameters
uuid
required
string

Group UUID

Request Body schema: application/json
name
required
string

Name of the Group

description
string

Description of the Group

email
string

Group contact email

Array of objects (RequestAttributeDto)

List of Custom Attributes

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "email": "string",
  • "customAttributes": [
    ]
}

Response samples

Content type
application/json
{
  • "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
  • "name": "Name",
  • "description": "string",
  • "email": "string",
  • "customAttributes": [
    ]
}

Delete Group

path Parameters
uuid
required
string

Group UUID

Responses

Response samples

Content type
application/json
{
  • "message": "Error message"
}

List Groups

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Group

Request Body schema: application/json
name
required
string

Name of the Group

description
string

Description of the Group

email
string

Group contact email

Array of objects (RequestAttributeDto)

List of Custom Attributes

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "email": "string",
  • "customAttributes": [
    ]
}

Response samples

Content type
application/json
{
  • "uuid": "string"
}

Delete multiple Groups

Request Body schema: application/json

Group UUIDs

Array
string

Responses

Request samples

Content type
application/json
[
  • "c2f685d4-6a3e-11ec-90d6-0242ac120003",
  • "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Settings

Settings API

Get platform settings

Responses

Response samples

Content type
application/json
{}

Update platform setting

Request Body schema: application/json
required
object (UtilsSettingsDto)

Utils settings of the platform

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Get notification settings

Responses

Response samples

Content type
application/json
{
  • "notificationsMapping": {
    }
}

Update notifications setting

Request Body schema: application/json
required
object

Type settings of the notification

Responses

Request samples

Content type
application/json
{
  • "notificationsMapping": {
    }
}

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Certificate Inventory

Certificate Inventory API

List Certificates

Request Body schema: application/json
Array of objects (SearchFilterRequestDto)

Certificate filter input

itemsPerPage
integer <int32> <= 1000
Default: 10

Number of entries per page

pageNumber
integer <int32>
Default: 1

Page number for the request

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ],
  • "itemsPerPage": 10,
  • "pageNumber": 1
}

Response samples

Content type
application/json
{
  • "certificates": [
    ],
  • "itemsPerPage": 0,
  • "pageNumber": 0,
  • "totalPages": 0,
  • "totalItems": 0
}

Update Group and/or Owner for multiple Certificates

In this operation, when the list of Certificate UUIDs are provided and the filter is left as null or undefined, then the change will be applied only to the list of Certificate UUIDs provided. When the filter is provided in the request, the list of UUIDs will be ignored and the change will be applied for the all the certificates that matches the filter criteria. To apply this change for all the Certificates in the inventory, provide an empty array "[]" for the value of "filters" in the request body

Request Body schema: application/json
groupUuid
string

Certificate Group UUID (set to empty string to remove certificate from group)

ownerUuid
string

Certificate owner user UUID (set to empty string to remove owner of certificate)

raProfileUuid
string

RA Profile UUID (set to empty string to remove certificate from RA profile)

certificateUuids
Array of strings

List of Certificate UUIDs

Array of objects (SearchFilterRequestDto)

Certificate filter input

Responses

Request samples

Content type
application/json
{
  • "groupUuid": "string",
  • "ownerUuid": "string",
  • "raProfileUuid": "string",
  • "certificateUuids": [
    ],
  • "filters": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Upload a new Certificate

Request Body schema: application/json
certificate
required
string

Base64 Content of the Certificate

required
Array of objects (RequestAttributeDto)

Custom Attributes for the Certificate

Responses

Request samples

Content type
application/json
{
  • "certificate": "string",
  • "customAttributes": [
    ]
}

Response samples

Content type
application/json
{
  • "uuid": "string"
}

Delete multiple certificates

In this operation, when the list of Certificate UUIDs are provided and the filter is left as null or undefined, then the change will be applied only to the list of Certificate UUIDs provided. When the filter is provided in the request, the list of UUIDs will be ignored and the change will be applied for the all the certificates that matches the filter criteria. To apply this change for all the Certificates in the inventory, provide an empty array "[]" for the value of "filters" in the request body

Request Body schema: application/json
uuids
Array of strings

List of Certificate UUIDs

Array of objects (SearchFilterRequestDto)

Certificate filter input

Responses

Request samples

Content type
application/json
{
  • "uuids": [
    ],
  • "filters": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "SUCCESS",
  • "failedItem": 0,
  • "message": "string"
}

Submit certificate request

Request Body schema: application/json
raProfileUuid
required
string <uuid>

RA Profile UUID. Required if CSR is not uploaded

sourceCertificateUuid
string <uuid>

Source certificate UUID to specify in case of renew/rekey operation

Array of objects (RequestAttributeDto)

List of attributes to create CSR. Required if CSR is not provided

Array of objects (RequestAttributeDto)

List of attributes to sign the CSR

request
string

Certificate signing request encoded as Base64 string

format
string (CertificateRequestFormat)
Default: "pkcs10"
Enum: "pkcs10" "crmf"

Certificate signing request format

tokenProfileUuid
string <uuid>

Token Profile UUID. Required if CSR is not uploaded

keyUuid
string <uuid>

Key UUID. Required if CSR is not uploaded

required
Array of objects (RequestAttributeDto)

List of RA Profile related Attributes to issue Certificate

Array of objects (RequestAttributeDto)

List of Custom Attributes

Responses

Request samples

Content type
application/json
{
  • "raProfileUuid": "b9278d9c-f0fb-4571-ad29-d552005d6e12",
  • "sourceCertificateUuid": "cef92ac9-d5a2-44b4-8d0a-6ae2f850acf7",
  • "csrAttributes": [
    ],
  • "signatureAttributes": [
    ],
  • "request": "string",
  • "format": "pkcs10",
  • "tokenProfileUuid": "66f2e24c-4f07-496b-b5c4-6fe8a5e8361a",
  • "keyUuid": "a0e39a6c-fae3-43d6-99c3-a3620775a368",
  • "issueAttributes": [
    ],
  • "customAttributes": [
    ]
}

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "commonName": "string",
  • "serialNumber": "string",
  • "issuerCommonName": "string",
  • "issuerDn": "string",
  • "subjectDn": "string",
  • "notBefore": "2019-08-24T14:15:22Z",
  • "notAfter": "2019-08-24T14:15:22Z",
  • "publicKeyAlgorithm": "string",
  • "signatureAlgorithm": "string",
  • "keySize": 0,
  • "state": "requested",
  • "validationStatus": "not_checked",
  • "raProfile": {
    },
  • "fingerprint": "string",
  • "group": {
    },
  • "owner": "string",
  • "ownerUuid": "string",
  • "certificateType": "X.509",
  • "issuerSerialNumber": "string",
  • "complianceStatus": "not_checked",
  • "issuerCertificateUuid": "string",
  • "privateKeyAvailability": true,
  • "trustedCa": true,
  • "extendedKeyUsage": [
    ],
  • "keyUsage": [
    ],
  • "basicConstraints": "string",
  • "metadata": [
    ],
  • "certificateContent": "string",
  • "subjectAlternativeNames": {
    },
  • "locations": [
    ],
  • "nonCompliantRules": [
    ],
  • "customAttributes": [
    ],
  • "key": {
    },
  • "certificateRequest": {
    },
  • "sourceCertificateUuid": "cef92ac9-d5a2-44b4-8d0a-6ae2f850acf7",
  • "issueAttributes": [
    ],
  • "revokeAttributes": [
    ],
  • "relatedCertificates": [
    ]
}

Get Certificate Content

Request Body schema: application/json

Certificate UUIDs

Array
string

Responses

Request samples

Content type
application/json
[
  • "c2f685d4-6a3e-11ec-90d6-0242ac120003",
  • "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

Content type
application/json
[
  • {
    }
]

Initiate Certificate Compliance Check

Request Body schema: application/json
certificateUuids
Array of strings

List of UUIDs of the Certificates

Responses

Request samples

Content type
application/json
{
  • "certificateUuids": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Get Certificate Details

path Parameters
uuid
required
string

Certificate UUID

Responses

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "commonName": "string",
  • "serialNumber": "string",
  • "issuerCommonName": "string",
  • "issuerDn": "string",
  • "subjectDn": "string",
  • "notBefore": "2019-08-24T14:15:22Z",
  • "notAfter": "2019-08-24T14:15:22Z",
  • "publicKeyAlgorithm": "string",
  • "signatureAlgorithm": "string",
  • "keySize": 0,
  • "state": "requested",
  • "validationStatus": "not_checked",
  • "raProfile": {
    },
  • "fingerprint": "string",
  • "group": {
    },
  • "owner": "string",
  • "ownerUuid": "string",
  • "certificateType": "X.509",
  • "issuerSerialNumber": "string",
  • "complianceStatus": "not_checked",
  • "issuerCertificateUuid": "string",
  • "privateKeyAvailability": true,
  • "trustedCa": true,
  • "extendedKeyUsage": [
    ],
  • "keyUsage": [
    ],
  • "basicConstraints": "string",
  • "metadata": [
    ],
  • "certificateContent": "string",
  • "subjectAlternativeNames": {
    },
  • "locations": [
    ],
  • "nonCompliantRules": [
    ],
  • "customAttributes": [
    ],
  • "key": {
    },
  • "certificateRequest": {
    },
  • "sourceCertificateUuid": "cef92ac9-d5a2-44b4-8d0a-6ae2f850acf7",
  • "issueAttributes": [
    ],
  • "revokeAttributes": [
    ],
  • "relatedCertificates": [
    ]
}

Delete a certificate

path Parameters
uuid
required
string

Certificate UUID

Responses

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Update Certificate Objects

path Parameters
uuid
required
string

Certificate UUID

Request Body schema: application/json
groupUuid
string

Certificate Group UUID (set to empty string to remove certificate from group)

ownerUuid
string

Certificate owner user UUID (set to empty string to remove owner of certificate)

raProfileUuid
string

RA Profile UUID (set to empty string to remove certificate from RA profile)

trustedCa
boolean

Mark CA certificate as trusted

Responses

Request samples

Content type
application/json
{
  • "groupUuid": "string",
  • "ownerUuid": "string",
  • "raProfileUuid": "string",
  • "trustedCa": true
}

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Download Certificate

path Parameters
uuid
required
string

Certificate UUID

certificateFormat
required
string (CertificateFormat)
Enum: "raw" "pkcs7"

Certificate format

query Parameters
encoding
required
string (CertificateFormatEncoding)
Enum: "pem" "der"

Responses

Response samples

Content type
application/json
{
  • "format": "raw",
  • "encoding": "pem",
  • "content": "string"
}

Get Certificate Validation Result

path Parameters
uuid
required
string

Certificate UUID

Responses

Response samples

Content type
application/json
{
  • "resultStatus": "not_checked",
  • "validationChecks": {
    }
}

Get Certificate event history

path Parameters
uuid
required
string

Certificate UUID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get certificate chain

Get certificate chain for the certificate with the given UUID. The certificate chain is returned in the order of the chain, with the first certificate being the certificate with the given UUID, up to the last identified certificate in the chain. If the certificate with the given UUID has status NEW or REJECTED, an empty list is returned.

path Parameters
uuid
required
string

Certificate UUID

query Parameters
withEndCertificate
boolean

Responses

Response samples

Content type
application/json
{
  • "completeChain": true,
  • "certificates": [
    ]
}

Download Certificate Chain in chosen format

path Parameters
uuid
required
string

Certificate UUID

certificateFormat
required
string (CertificateFormat)
Enum: "raw" "pkcs7"

Certificate format

query Parameters
withEndCertificate
boolean
encoding
required
string (CertificateFormatEncoding)
Enum: "pem" "der"

Responses

Response samples

Content type
application/json
{
  • "format": "raw",
  • "encoding": "pem",
  • "content": "string",
  • "completeChain": true
}

List Certificates Approvals

path Parameters
uuid
required
string

Certificate UUID

query Parameters
required
object (PaginationRequestDto)

Responses

Response samples

Content type
application/json
{
  • "itemsPerPage": 0,
  • "pageNumber": 0,
  • "totalPages": 0,
  • "totalItems": 0,
  • "approvals": [
    ]
}

List of available Locations for the Certificate

path Parameters
certificateUuid
required
string

Certificate UUID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Certificate searchable fields information

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get CSR Generation Attributes

Responses

Response samples

Content type
application/json
[
  • {
    }
]

SCEP Profile Management

SCEP Profile Management API

Get details of SCEP Profile

path Parameters
uuid
required
string

SCEP Profile UUID

Responses

Response samples

Content type
application/json
{
  • "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
  • "name": "Name",
  • "enabled": true,
  • "description": "Sample description",
  • "raProfile": {
    },
  • "includeCaCertificate": true,
  • "includeCaCertificateChain": true,
  • "renewThreshold": 30,
  • "scepUrl": "https://some-server.com/api/v1/protocols/scep/profile/pkiclient.exe",
  • "enableIntune": true,
  • "issueCertificateAttributes": [
    ],
  • "customAttributes": [
    ],
  • "caCertificate": {
    },
  • "intuneTenant": "string",
  • "intuneApplicationId": "string"
}

Edit SCEP Profile

path Parameters
uuid
required
string

SCEP Profile UUID

Request Body schema: application/json
description
string

Description of the SCEP Profile

raProfileUuid
string

RA Profile UUID

required
Array of objects (RequestAttributeDto)

List of Attributes to issue Certificate

caCertificateUuid
required
string

UUID of the Certificate to be used as CA Certificate for SCEP Requests

Array of objects (RequestAttributeDto)

List of Custom Attributes

renewalThreshold
integer <int32>

Minimum expiry days to allow renewal of certificate. Empty or the value '0' will be considered as null and half life of the certificate validity will be considered for the protocol

includeCaCertificate
boolean
Default: false

Include CA Certificate in the SCEP Message response

includeCaCertificateChain
boolean
Default: false

Include CA Certificate Chain in the SCEP Message response

challengePassword
string

Challenge Password for the SCEP Request

enableIntune
boolean

Status of Intune

intuneTenant
string

Intune Tenant

intuneApplicationId
string

Intune Application ID

intuneApplicationKey
string

Intune Application Key

Responses

Request samples

Content type
application/json
{
  • "description": "Sample description",
  • "raProfileUuid": "6b55de1c-844f-11ec-a8a3-0242ac120002",
  • "issueCertificateAttributes": [
    ],
  • "caCertificateUuid": "string",
  • "customAttributes": [
    ],
  • "renewalThreshold": 0,
  • "includeCaCertificate": false,
  • "includeCaCertificateChain": false,
  • "challengePassword": "string",
  • "enableIntune": true,
  • "intuneTenant": "string",
  • "intuneApplicationId": "string",
  • "intuneApplicationKey": "string"
}

Response samples

Content type
application/json
{
  • "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
  • "name": "Name",
  • "enabled": true,
  • "description": "Sample description",
  • "raProfile": {
    },
  • "includeCaCertificate": true,
  • "includeCaCertificateChain": true,
  • "renewThreshold": 30,
  • "scepUrl": "https://some-server.com/api/v1/protocols/scep/profile/pkiclient.exe",
  • "enableIntune": true,
  • "issueCertificateAttributes": [
    ],
  • "customAttributes": [
    ],
  • "caCertificate": {
    },
  • "intuneTenant": "string",
  • "intuneApplicationId": "string"
}

Delete SCEP Profile

path Parameters
uuid
required
string

SCEP Profile UUID

Responses

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Get list of SCEP Profiles

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create SCEP Profile

Request Body schema: application/json
description
string

Description of the SCEP Profile

raProfileUuid
string

RA Profile UUID

required
Array of objects (RequestAttributeDto)

List of Attributes to issue Certificate

caCertificateUuid
required
string

UUID of the Certificate to be used as CA Certificate for SCEP Requests

Array of objects (RequestAttributeDto)

List of Custom Attributes

renewalThreshold
integer <int32>

Minimum expiry days to allow renewal of certificate. Empty or the value '0' will be considered as null and half life of the certificate validity will be considered for the protocol

includeCaCertificate
boolean
Default: false

Include CA Certificate in the SCEP Message response

includeCaCertificateChain
boolean
Default: false

Include CA Certificate Chain in the SCEP Message response

challengePassword
string

Challenge Password for the SCEP Request

enableIntune
boolean

Status of Intune

intuneTenant
string

Intune Tenant

intuneApplicationId
string

Intune Application ID

intuneApplicationKey
string

Intune Application Key

name
required
string

Name of the SCEP Profile

Responses

Request samples

Content type
application/json
{
  • "description": "Sample description",
  • "raProfileUuid": "6b55de1c-844f-11ec-a8a3-0242ac120002",
  • "issueCertificateAttributes": [
    ],
  • "caCertificateUuid": "string",
  • "customAttributes": [
    ],
  • "renewalThreshold": 0,
  • "includeCaCertificate": false,
  • "includeCaCertificateChain": false,
  • "challengePassword": "string",
  • "enableIntune": true,
  • "intuneTenant": "string",
  • "intuneApplicationId": "string",
  • "intuneApplicationKey": "string",
  • "name": "Profile Name 1"
}

Response samples

Content type
application/json
{
  • "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
  • "name": "Name",
  • "enabled": true,
  • "description": "Sample description",
  • "raProfile": {
    },
  • "includeCaCertificate": true,
  • "includeCaCertificateChain": true,
  • "renewThreshold": 30,
  • "scepUrl": "https://some-server.com/api/v1/protocols/scep/profile/pkiclient.exe",
  • "enableIntune": true,
  • "issueCertificateAttributes": [
    ],
  • "customAttributes": [
    ],
  • "caCertificate": {
    },
  • "intuneTenant": "string",
  • "intuneApplicationId": "string"
}

Update RA Profile for SCEP Profile

path Parameters
uuid
required
string

SCEP Profile UUID

raProfileUuid
required
string

RA Profile UUID

Responses

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Enable SCEP Profile

path Parameters
uuid
required
string

SCEP Profile UUID

Responses

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Disable SCEP Profile

path Parameters
uuid
required
string

SCEP Profile UUID

Responses

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Enable multiple SCEP Profiles

Request Body schema: application/json

SCEP Profile UUIDs

Array
string

Responses

Request samples

Content type
application/json
[
  • "c2f685d4-6a3e-11ec-90d6-0242ac120003",
  • "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Disable multiple SCEP Profile

Request Body schema: application/json

SCEP Profile UUIDs

Array
string

Responses

Request samples

Content type
application/json
[
  • "c2f685d4-6a3e-11ec-90d6-0242ac120003",
  • "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Get list of certificates eligible for CA certificate of SCEP requests

query Parameters
intuneEnabled
required
boolean

flag to return certificates that are eligible for Intune integration

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete multiple SCEP Profiles

Request Body schema: application/json

SCEP Profile UUIDs

Array
string

Responses

Request samples

Content type
application/json
[
  • "c2f685d4-6a3e-11ec-90d6-0242ac120003",
  • "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

Content type
application/json
[
  • {
    }
]

Force delete multiple SCEP Profiles

Request Body schema: application/json

SCEP Profile UUIDs

Array
string

Responses

Request samples

Content type
application/json
[
  • "c2f685d4-6a3e-11ec-90d6-0242ac120003",
  • "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

Content type
application/json
[
  • {
    }
]

Compliance Profile Management

Compliance Profile Management API

List of available Compliance Profiles

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add Compliance Profile

Request Body schema: application/json
name
required
string

Name of the Compliance Profile

description
string

Description of the Compliance Profile

Array of objects (ComplianceProfileRulesRequestDto)

Rules to be associated with the Compliance Profile. Profiles can be created without rules and can be added later

Array of objects (RequestAttributeDto)

List of Custom Attributes

Responses

Request samples

Content type
application/json
{
  • "name": "Profile 1",
  • "description": "Profile 1",
  • "rules": [
    ],
  • "customAttributes": [
    ]
}

Response samples

Content type
application/json
{
  • "uuid": "string"
}

Delete multiple Compliance Profiles

Request Body schema: application/json

Compliance Profile UUIDs

Array
string

Responses

Request samples

Content type
application/json
[
  • "c2f685d4-6a3e-11ec-90d6-0242ac120003",
  • "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

Content type
application/json
[
  • {
    }
]

Add rule to a Compliance Profile

path Parameters
uuid
required
string

Compliance Profile UUID

Request Body schema: application/json
connectorUuid
required
string

UUID of the Compliance Provider

kind
required
string

Kind of the Compliance Provider

ruleUuid
required
string

UUID of the rule

Array of objects (RequestAttributeDto)

Attributes for the rule

Responses

Request samples

Content type
application/json
{
  • "connectorUuid": "1212a-34dddf34-4334f-34ddfvfdg1y3",
  • "kind": "default",
  • "ruleUuid": "1212a-34dddf34-4334f-34ddfvfdg1y3",
  • "attributes": [
    ]
}

Response samples

Content type
application/json
{
  • "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
  • "name": "Name",
  • "description": "Sample rule description",
  • "connectorName": "string",
  • "connectorUuid": "string",
  • "kind": "string",
  • "groupUuid": "string",
  • "certificateType": "X.509",
  • "attributes": [
    ],
  • "complianceProfileUuid": "string",
  • "complianceProfileName": "string"
}

Delete rule from a Compliance Profile

path Parameters
uuid
required
string

Compliance Profile UUID

Request Body schema: application/json
connectorUuid
required
string

UUID of the Compliance Provider

kind
required
string

Kind of the Compliance Provider

ruleUuid
required
string

UUID of the rule

Responses

Request samples

Content type
application/json
{
  • "connectorUuid": "1212a-34dddf34-4334f-34ddfvfdg1y3",
  • "kind": "default",
  • "ruleUuid": "1212a-34dddf34-4334f-34ddfvfdg1y3"
}

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Add group to a Compliance Profile

path Parameters
uuid
required
string

Compliance Profile UUID

Request Body schema: application/json
connectorUuid
required
string

UUID of the Compliance Provider

kind
required
string

Kind of the Compliance Provider

groupUuid
required
string

UUID of the group

Responses

Request samples

Content type
application/json
{
  • "connectorUuid": "1212a-34dddf34-4334f-34ddfvfdg1y3",
  • "kind": "default",
  • "groupUuid": "1212a-34dddf34-4334f-34ddfvfdg1y3"
}

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Delete group from a Compliance Profile

path Parameters
uuid
required
string

Compliance Profile UUID

Request Body schema: application/json
connectorUuid
required
string

UUID of the Compliance Provider

kind
required
string

Kind of the Compliance Provider

groupUuid
required
string

UUID of the group

Responses

Request samples

Content type
application/json
{
  • "connectorUuid": "1212a-34dddf34-4334f-34ddfvfdg1y3",
  • "kind": "default",
  • "groupUuid": "1212a-34dddf34-4334f-34ddfvfdg1y3"
}

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Initiate Certificate Compliance Check

Request Body schema: application/json

RA Profile UUIDs

Array
string

Responses

Request samples

Content type
application/json
[
  • "c2f685d4-6a3e-11ec-90d6-0242ac120003",
  • "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Disassociate Compliance Profile to RA Profile

path Parameters
uuid
required
string

Compliance Profile UUID

Request Body schema: application/json
raProfileUuids
required
Array of strings

List of UUIDs of RA Profiles to be associated

Responses

Request samples

Content type
application/json
{
  • "raProfileUuids": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Associate Compliance Profile to RA Profile

path Parameters
uuid
required
string

Compliance Profile UUID

Request Body schema: application/json
raProfileUuids
required
Array of strings

List of UUIDs of RA Profiles to be associated

Responses

Request samples

Content type
application/json
{
  • "raProfileUuids": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Details of a Compliance Profiles

path Parameters
uuid
required
string

Compliance Profile UUID

Responses

Response samples

Content type
application/json
{
  • "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
  • "name": "Name",
  • "description": "string",
  • "rules": [
    ],
  • "groups": [
    ],
  • "raProfiles": [
    ],
  • "customAttributes": [
    ]
}

Delete Compliance Profile

path Parameters
uuid
required
string

Compliance Profile UUID

Responses

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Get RA Profiles for a Compliance Profile

path Parameters
uuid
required
string

Compliance Profile UUID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Compliance rules

query Parameters
complianceProvider
string
kind
string
certificateType
Array of strings (CertificateType)
Items Enum: "X.509" "SSH"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Compliance groups

query Parameters
complianceProvider
string
kind
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Force delete Compliance Profiles

Request Body schema: application/json
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
[
  • {
    }
]

Cryptographic Operations Controller

Cryptographic Operations Controller API

Verify data using a Key

path Parameters
tokenInstanceUuid
required
string

Token Instance UUID

tokenProfileUuid
required
string

Token Profile UUID

uuid
required
string

Key UUID

keyItemUuid
required
string

Key Item UUID

Request Body schema: application/json
required
Array of objects (RequestAttributeDto)

List of signature Attributes

required
Array of objects (SignatureRequestData)

Data to be signed

required
Array of objects (SignatureRequestData)

Signatures to verify

Responses

Request samples

Content type
application/json
{
  • "signatureAttributes": [
    ],
  • "data": [
    ],
  • "signatures": [
    ]
}

Response samples

Content type
application/json
{
  • "verifications": [
    ]
}

Sign data using a Key

path Parameters
tokenInstanceUuid
required
string

Token Instance UUID

tokenProfileUuid
required
string

Token Profile UUID

uuid
required
string

Key UUID

keyItemUuid
required
string

Key Item UUID

Request Body schema: application/json
required
Array of objects (RequestAttributeDto)

List of signature Attributes

required
Array of objects (SignatureRequestData)

Data to be signed

Responses

Request samples

Content type
application/json
{
  • "signatureAttributes": [
    ],
  • "data": [
    ]
}

Response samples

Content type
application/json
{
  • "signatures": [
    ]
}

Encrypt data using a Key

path Parameters
tokenInstanceUuid
required
string

Token Instance UUID

tokenProfileUuid
required
string

Token Profile UUID

uuid
required
string

Key UUID

keyItemUuid
required
string

Key Item UUID

Request Body schema: application/json
required
Array of objects (RequestAttributeDto)

List of cipher Attributes

required
Array of objects (CipherRequestData)

Encrypted/decrypted data

Responses

Request samples

Content type
application/json
{
  • "cipherAttributes": [
    ],
  • "cipherData": [
    ]
}

Response samples

Content type
application/json
{
  • "encryptedData": [
    ]
}

Decrypt data using a Key

path Parameters
tokenInstanceUuid
required
string

Token Instance UUID

tokenProfileUuid
required
string

Token Profile UUID

uuid
required
string

Key UUID

keyItemUuid
required
string

Key Item UUID

Request Body schema: application/json
required
Array of objects (RequestAttributeDto)

List of cipher Attributes

required
Array of objects (CipherRequestData)

Encrypted/decrypted data

Responses

Request samples

Content type
application/json
{
  • "cipherAttributes": [
    ],
  • "cipherData": [
    ]
}

Response samples

Content type
application/json
{
  • "decryptedData": [
    ]
}

Generate random data

path Parameters
tokenInstanceUuid
required
string

Token Instance UUID

Request Body schema: application/json
length
required
integer <int32>

Number of random bytes to generate

Array of objects (RequestAttributeDto)

Random generator Attributes

Responses

Request samples

Content type
application/json
{
  • "length": 0,
  • "attributes": [
    ]
}

Response samples

Content type
application/json
{
  • "data": "string"
}

List of signature Attributes

path Parameters
tokenInstanceUuid
required
string

Token Instance UUID

tokenProfileUuid
required
string

Token Profile UUID

uuid
required
string

Key instance UUID

keyItemUuid
required
string

Key Item UUID

algorithm
required
string (KeyAlgorithm)
Enum: "RSA" "ECDSA" "FALCON" "CRYSTALS-Dilithium" "SPHINCS+"

Cryptographic algorithm

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List of cipher Attributes

path Parameters
tokenInstanceUuid
required
string

Token Instance UUID

tokenProfileUuid
required
string

Token Profile UUID

uuid
required
string

Key UUID

keyItemUuid
required
string

Key Item UUID

algorithm
required
string (KeyAlgorithm)
Enum: "RSA" "ECDSA" "FALCON" "CRYSTALS-Dilithium" "SPHINCS+"

Cryptographic algorithm

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List of random generator Attributes

path Parameters
tokenInstanceUuid
required
string

Token Instance UUID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Enums

Enums API

Get platform enums

Responses

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Connector Authentication

Connector Authentication API

Validate JWT auth Attributes

Request Body schema: application/json
Array
uuid
required
string

UUID of the Attribute

name
required
string

Name of the Attribute

contentType
required
string (AttributeContentType)
Enum: "string" "text" "integer" "boolean" "float" "date" "time" "datetime" "secret" "file" "credential" "codeblock" "object"

Type of the attribute content.

required
Array of BooleanAttributeContent (object) or CodeBlockAttributeContent (object) or CredentialAttributeContent (object) or DateAttributeContent (object) or DateTimeAttributeContent (object) or FileAttributeContent (object) or FloatAttributeContent (object) or IntegerAttributeContent (object) or ObjectAttributeContent (object) or SecretAttributeContent (object) or StringAttributeContent (object) or TextAttributeContent (object) or TimeAttributeContent (object) (BaseAttributeContentDto)

Content of the Attribute

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Validate certificate auth Attributes

Request Body schema: application/json
Array
uuid
required
string

UUID of the Attribute

name
required
string

Name of the Attribute

contentType
required
string (AttributeContentType)
Enum: "string" "text" "integer" "boolean" "float" "date" "time" "datetime" "secret" "file" "credential" "codeblock" "object"

Type of the attribute content.

required
Array of BooleanAttributeContent (object) or CodeBlockAttributeContent (object) or CredentialAttributeContent (object) or DateAttributeContent (object) or DateTimeAttributeContent (object) or FileAttributeContent (object) or FloatAttributeContent (object) or IntegerAttributeContent (object) or ObjectAttributeContent (object) or SecretAttributeContent (object) or StringAttributeContent (object) or TextAttributeContent (object) or TimeAttributeContent (object) (BaseAttributeContentDto)

Content of the Attribute

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Validate basic auth Attributes

Request Body schema: application/json
Array
uuid
required
string

UUID of the Attribute

name
required
string

Name of the Attribute

contentType
required
string (AttributeContentType)
Enum: "string" "text" "integer" "boolean" "float" "date" "time" "datetime" "secret" "file" "credential" "codeblock" "object"

Type of the attribute content.

required
Array of BooleanAttributeContent (object) or CodeBlockAttributeContent (object) or CredentialAttributeContent (object) or DateAttributeContent (object) or DateTimeAttributeContent (object) or FileAttributeContent (object) or FloatAttributeContent (object) or IntegerAttributeContent (object) or ObjectAttributeContent (object) or SecretAttributeContent (object) or StringAttributeContent (object) or TextAttributeContent (object) or TimeAttributeContent (object) (BaseAttributeContentDto)

Content of the Attribute

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Validate API Key Attributes

Request Body schema: application/json
Array
uuid
required
string

UUID of the Attribute

name
required
string

Name of the Attribute

contentType
required
string (AttributeContentType)
Enum: "string" "text" "integer" "boolean" "float" "date" "time" "datetime" "secret" "file" "credential" "codeblock" "object"

Type of the attribute content.

required
Array of BooleanAttributeContent (object) or CodeBlockAttributeContent (object) or CredentialAttributeContent (object) or DateAttributeContent (object) or DateTimeAttributeContent (object) or FileAttributeContent (object) or FloatAttributeContent (object) or IntegerAttributeContent (object) or ObjectAttributeContent (object) or SecretAttributeContent (object) or StringAttributeContent (object) or TextAttributeContent (object) or TimeAttributeContent (object) (BaseAttributeContentDto)

Content of the Attribute

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "message": "Error message"
}

Get list of Authentication Types

Responses

Response samples

Content type
application/json
[
  • "string"
]

Get JWT auth Attributes

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Attributes for certificate auth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get basic auth Attributes

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get API Key auth Attributes

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Resource Management

Resource Management API

Retrieve list of resources with information and settings

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve filter fields that can be used for creating rule conditions and actions

path Parameters
resource
required
string (Resource)
Enum: "NONE" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "notificationInstances" "users" "roles" "acmeAccounts" "acmeProfiles" "scepProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals"

Resource

query Parameters
settable
boolean

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve a list of all events that can be triggered by a resource

path Parameters
resource
required
string (Resource)
Enum: "NONE" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "notificationInstances" "users" "roles" "acmeAccounts" "acmeProfiles" "scepProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals"

Resource

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Connector Registration

Connector Registration API

Register a Connector

Request Body schema: application/json
name
required
string

Name of the Connector

url
required
string

URL of the Connector to connect

authType
required
string (AuthType)
Enum: "none" "basic" "certificate" "apiKey" "jwt"

Type of authentication for the Connector

Array of objects (RequestAttributeDto)

List of authentication Attributes. Required if the authentication type is not NONE

Array of objects (RequestAttributeDto)

List of Custom Attributes

Responses

Request samples

Content type
application/json
{
  • "name": "Connector1",
  • "url": "http://network-discovery-provicer:8080",
  • "authType": "none",
  • "authAttributes": [
    ],
  • "customAttributes": [
    ]
}

Response samples

Content type
application/json
{
  • "uuid": "string"
}

Role Management

Role Management API

Get role details

path Parameters
roleUuid
required
string

Role UUID

Responses

Response samples

Content type
application/json
{
  • "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
  • "name": "Name",
  • "description": "string",
  • "email": "string",
  • "systemRole": true,
  • "users": [
    ],
  • "customAttributes": [
    ]
}

Update Role

path Parameters
roleUuid
required
string

Role UUID

Request Body schema: application/json
name
string

Name of the role

description
string

Description for the role

email
string

Role contact email

Array of objects (RequestAttributeDto)

List of Custom Attributes

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "email": "string",
  • "customAttributes": [
    ]
}

Response samples

Content type
application/json
{
  • "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
  • "name": "Name",
  • "description": "string",
  • "email": "string",
  • "systemRole": true,
  • "users": [
    ],
  • "customAttributes": [
    ]
}

Delete Role

path Parameters
roleUuid
required
string

Role UUID

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "code": "string",
  • "message": "string"
}

Update Resource Objects to a Role

path Parameters
roleUuid
required
string

Role UUID

resourceUuid
required
string

Resource UUID

objectUuid
required
string

Object UUID

Request Body schema: application/json
uuid
required
string

UUID of the Object

name
required
string

Name of the Object

allow
Array of strings

Allowed Action list

deny
Array of strings

Denied Action list

Responses

Request samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "allow": [
    ],
  • "deny": [
    ]
}

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "code": "string",
  • "message": "string"
}

Update Resource Objects to a Role

path Parameters
roleUuid
required
string

Role UUID

resourceUuid
required
string

Resource UUID

objectUuid
required
string

Object UUID

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "code": "string",
  • "message": "string"
}

List Roles

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Role

Request Body schema: application/json
name
string

Name of the role

description
string

Description for the role

email
string

Role contact email

Array of objects (RequestAttributeDto)

List of Custom Attributes

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "email": "string",
  • "customAttributes": [
    ]
}

Response samples

Content type
application/json
{
  • "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
  • "name": "Name",
  • "description": "string",
  • "email": "string",
  • "systemRole": true,
  • "users": [
    ],
  • "customAttributes": [
    ]
}

Get Permissions of a Role

path Parameters
roleUuid
required
string

Role UUID

Responses

Response samples

Content type
application/json
{
  • "allowAllResources": true,
  • "resources": [
    ]
}

Add permissions to Role

path Parameters
roleUuid
required
string

Role UUID

Request Body schema: application/json
allowAllResources
required
boolean

Allow all resources, True = Yes, False = No

Array of objects (ResourcePermissionsRequestDto)

Resources

Responses

Request samples

Content type
application/json
{
  • "allowAllResources": true,
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "allowAllResources": true,
  • "resources": [
    ]
}

Get Resource Objects of a Role

path Parameters
roleUuid
required
string

Role UUID

resourceUuid
required
string

Resource UUID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add Resource Objects to a Role

path Parameters
roleUuid
required
string

Role UUID

resourceUuid
required
string

Resource UUID

Request Body schema: application/json
Array
uuid
required
string

UUID of the Object

name
required
string

Name of the Object

allow
Array of strings

Allowed Action list

deny
Array of strings

Denied Action list

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "code": "string",
  • "message": "string"
}

Get Role Users

path Parameters
roleUuid
required
string

Role UUID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add users to Role

path Parameters
roleUuid
required
string

Role UUID

Request Body schema: application/json

User UUIDs

Array
string

Responses

Request samples

Content type
application/json
[
  • "c2f685d4-6a3e-11ec-90d6-0242ac120003",
  • "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

Content type
application/json
{
  • "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
  • "name": "Name",
  • "description": "string",
  • "email": "string",
  • "systemRole": true,
  • "users": [
    ],
  • "customAttributes": [
    ]
}

Get Resources of a Role

path Parameters
roleUuid
required
string

Role UUID

resourceUuid
required
string

Resource UUID

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "allowAllActions": true,
  • "actions": [
    ],
  • "objects": [
    ]
}

Approval Inventory

Approval Inventory API

Rejecting of the Approval

path Parameters
uuid
required
string

Approval UUID

Responses

Rejecting of Recipient of the Approval

path Parameters
uuid
required
string

Approval UUID

Request Body schema: application/json
comment
string

Responses

Request samples

Content type
application/json
{
  • "comment": "string"
}

Approving of the Approval

path Parameters
uuid
required
string

Approval UUID

Responses

Approving of Recipient of the Approval

path Parameters
uuid
required
string

Approval UUID

Request Body schema: application/json
comment
string

Responses

Request samples

Content type
application/json
{
  • "comment": "string"
}

List of Approvals

query Parameters
required
object (PaginationRequestDto)

Responses

Response samples

Content type
application/json
{
  • "itemsPerPage": 0,
  • "pageNumber": 0,
  • "totalPages": 0,
  • "totalItems": 0,
  • "approvals": [
    ]
}

Get Approval Detail

path Parameters
uuid
required
string

Approval UUID

Responses

Response samples

Content type
application/json
{
  • "approvalUuid": "string",
  • "creatorUuid": "string",
  • "creatorUsername": "string",
  • "version": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "expiryAt": "2019-08-24T14:15:22Z",
  • "closedAt": "2019-08-24T14:15:22Z",
  • "status": "PENDING",
  • "resource": "NONE",
  • "resourceAction": "string",
  • "objectUuid": "string",
  • "approvalProfileName": "string",
  • "approvalProfileUuid": "string",
  • "expiry": 0,
  • "description": "string",
  • "approvalSteps": [
    ]
}

List of User's Approvals

query Parameters
required
object (PaginationRequestDto)
required
object (ApprovalUserDto)

Select if you want to list all history of approvals by user

Responses

Response samples

Content type
application/json
{
  • "itemsPerPage": 0,
  • "pageNumber": 0,
  • "totalPages": 0,
  • "totalItems": 0,
  • "approvals": [
    ]
}